https://github.com/isayanpal/learnsync
LearnSync is an innovative adaptive learning assessment system that incorporates personality tests to detect disorders like ADHD, dyslexia, and autism, followed by personalized AI responses. This project aims to create a more inclusive and effective learning environment for all users.
https://github.com/isayanpal/learnsync
cohere-ai expressjs framer-motion mongodb nodejs postman reactjs redux-toolkit tailwindcss
Last synced: 2 months ago
JSON representation
LearnSync is an innovative adaptive learning assessment system that incorporates personality tests to detect disorders like ADHD, dyslexia, and autism, followed by personalized AI responses. This project aims to create a more inclusive and effective learning environment for all users.
- Host: GitHub
- URL: https://github.com/isayanpal/learnsync
- Owner: isayanpal
- License: mit
- Created: 2024-10-19T09:53:15.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-10-20T15:32:42.000Z (12 months ago)
- Last Synced: 2024-12-12T05:06:36.292Z (10 months ago)
- Topics: cohere-ai, expressjs, framer-motion, mongodb, nodejs, postman, reactjs, redux-toolkit, tailwindcss
- Language: JavaScript
- Homepage: https://learn-sync-v1.vercel.app
- Size: 921 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LearnSync 🧠🤖
LearnSync is an innovative adaptive learning assessment system that incorporates personality tests to detect disorders like ADHD, dyslexia, and autism, followed by personalized AI responses. This project aims to create a more inclusive and effective learning environment for all users.
## 🚀 Live here - https://learn-sync-v1.vercel.app
## 🌟 Features
- 📝 Personality test for detecting learning disorders
- 🤖 AI-powered disorder detection
- 💬 Interactive companion with personalized responses
- 📊 Adaptive learning interface
- 🔐 User authentication and session management
- 🗣️ Text-to-Speech: React Window Synthesizer
## 🛠️ Tech Stack
- Frontend: React ⚛️, Tailwind CSS 🎨, Redux 🔄, Framer Motion 🎭
- Backend: Node.js 🟢, Express 🚂
- Database: MongoDB 🍃
- AI Integration: Cohere API 🧠
- Testing: Postman 📮
- Deploy - Vercel & Render 🚀
## 🚀 Getting Started
### Project Setup
1. Clone the repository:
```bash
git clone https://github.com/isayanpal/LearnSync.git
```
### Frontend Setup
1. Navigate to client
```bash
cd client
```
2. Install dependencies:
```bash
npm install
```
3. Set up environment variables:
Create a `.env` file in the client directory and add the following:
```
VITE_API_BASE_URL=http://localhost:5000
```
4. Start the development server:
```bash
npm run dev
```
### Backend Setup
1. Navigate to server
```bash
cd server
```
2. Install dependencies:
```bash
npm install
```
3. Set up environment variables:
Create a `.env` file in the server directory and add the following:
```
MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret
COHERE_API_KEY=your_cohere_api_key
PORT=5000
CORS_ORIGIN=http://localhost:5173
```
4. Start the server:
```bash
npm run dev
```
## 🌐 API Endpoints
- `POST /api/v1/auth/register`: User authentication
- `POST /api/v1/auth/login`: User authentication
- `GET /api/v1/auth/get-questions`: Fetch personality test questions
- `POST /api/v1/test/submit-answers`: Submit personality test answers
- `POST /api/v1/chat-bot`: Get AI-powered responses
## 🤝 Contributing
We welcome contributions to LearnSync! Please feel free to submit issues, fork the repository and send pull requests!
## 📄 License
This project is licensed under: [MIT licensed](./LICENSE)
## 🙏 Acknowledgements
- [Cohere](https://cohere.ai/) for providing the AI API
- [MongoDB](https://www.mongodb.com/) for the database solution
- [Framer Motion](https://www.framer.com/motion/) for smooth animations
- All contributors who have helped shape LearnSync
---
Happy Learning with LearnSync! 🎓✨