Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.88 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.88 KB
Raw

🤖 ChatGPT Study With Me AI

This is a ChatGPT based platform for education that can help you learn a new subject without pain. This project is a full-stack project written using TypeScript.

📝 Documents

  • PRD&TRD - Product Requirement Document and Technical Requirement Document for the application.
  • Storybook Documentation - Storybook documentation for the application.
  • API Documentation - API documentation for the application. Please run npm install and npm run start and login to the application before accessing the API documentation for authentication.
  • Database Playground - http://localhost:3001/playground GraphQL playground for the database. Please run npm install and npm run start before accessing the database playground for authentication.

🚀 Getting Started

To get started with this project, run npm install and npm run start in the project root directory.

More Information

For more information about the project, please visit the README For Frontend and README For Backend files.

🛠️ Tech Stack

This project supported by / uses the following technologies:

  • ChatGPT
  • React
  • TypeScript
  • Sass
  • NestJS
  • GraphQL
  • Cypher
  • AWS
  • Vercel
  • Namecheap

👨‍💻 Author

This project create and maintained by @clean99.

📄 Open Source License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International license. You are free to use and modify the project for non-commercial purposes as long as you provide attribution to the original author. If you wish to use this project for commercial purposes, please contact the author.