https://github.com/premshinde-2013/hackathon
Explore our robust LMS platform built with TypeScript, Node.js, Express.js, MongoDB, Redis, Next.js 13, RTK Query, and Socket.IO. Seamlessly manage learning activities with powerful features. Empower your educational endeavors with our full-stack solution for efficient, interactive learning experiences.
https://github.com/premshinde-2013/hackathon
cloudinary expressjs mongodb nextjs14 nextui nodejs redis render socket-io tailwindcss typescipt upstash-redis vercel-deployment
Last synced: 3 months ago
JSON representation
Explore our robust LMS platform built with TypeScript, Node.js, Express.js, MongoDB, Redis, Next.js 13, RTK Query, and Socket.IO. Seamlessly manage learning activities with powerful features. Empower your educational endeavors with our full-stack solution for efficient, interactive learning experiences.
- Host: GitHub
- URL: https://github.com/premshinde-2013/hackathon
- Owner: PremShinde-2013
- Created: 2024-12-20T05:13:39.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-12-20T05:42:34.000Z (5 months ago)
- Last Synced: 2025-01-09T19:05:12.171Z (4 months ago)
- Topics: cloudinary, expressjs, mongodb, nextjs14, nextui, nodejs, redis, render, socket-io, tailwindcss, typescipt, upstash-redis, vercel-deployment
- Homepage: https://learnifypro-lms.vercel.app/
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LearnifyPro 🚀
Welcome to **LearnifyPro** - the ultimate Learning Management System (LMS) that empowers educators, students, and administrators to create, manage, and excel in the world of learning!
This project is built with modern technologies like React, Node.js, MongoDB, and TypeScript to deliver a robust and user-friendly LMS.
---
## 🎥 Watch the Overview Video
Here’s a quick overview of LearnifyPro:
https://github.com/user-attachments/assets/05a94cc5-9360-4615-babf-c1b56bd6589c
This video showcases the core features of LearnifyPro, such as course management, real-time communication, and the sleek user interface.
## 🚀 Key Features
- **Efficient Backend**: Powered by Node.js and Express.js for fast and scalable server-side operations.
- **Real-time Communication**: Seamless, live updates with Socket.IO.
- **Data Management**: Reliable storage with MongoDB.
- **Performance Boost**: Optimized with Redis caching mechanism for faster data retrieval.
- **Client-side Rendering**: Smooth, fast user experiences using Next.js.
- **Stylish UI**: Aesthetic and responsive UI enhanced by Next UI, and Tailwind CSS.
- **Effortless Deployment**: Frontend deployed on Vercel and backend on Render for easy management.
- **Admin Panel**: Manage courses and users with ease.
- **Payment Integration**: Stripe integration for subscription management.
- **Authentication & Security**: Using JWT for secure user management.
## 🛠️ Tech Stack
| **Category** | **Technology** |
|---------------------|---------------------------------------------------------|
| **Frontend** | Next.js, Tailwind CSS, Material-UI, Next UI |
| **Backend** | Node.js, Express.js |
| **Database** | MongoDB, Redis |
| **Real-time Features**| Socket.IO |
| **Authentication** | JWT |
| **Payment Gateway** | Stripe |
| **Deployment** | Vercel (Frontend), Render (Backend) |
| **UI Components** | Shadcn-UI, Framer Motion |
## 🎯 Project Setup
Follow these steps to clone, install, and run LearnifyPro locally.
### 1️⃣ Clone the Repository
Open your terminal and run the following command:
```bash
# Clone the repository
git clone https://github.com/PremShinde-2013/Hackathon.git
# Move into the project directory
cd Hackathon
```
### 2️⃣ Set Up the Server
Navigate to the server folder:
```bash
cd server
```
Install the dependencies:
```bash
pnpm install
```
Create a `.env` file in the server directory with the following details:
```env
PORT = 8000
ORIGIN = ['http://localhost:3000']
NODE_ENV = development
DB_URL = 'mongodb+srv://:@lms.iukma3o.mongodb.net/LMS'
CLOUD_NAME =
CLOUD_API_KEY =
CLOUD_SECRET_KEY =
REDIS_URL = rediss://
ACTIVATION_SECRET =
ACCESS_TOKEN =
REFRESH_TOKEN =
ACCESS_TOKEN_EXPIRE = 5
REFRESH_TOKEN_EXPIRE = 3
SMTP_HOST= smtp.gmail.com
SMTP_SERVICE=gmail
SMTP_PORT=465
SMTP_MAIL=
SMTP_PASSWORD=
VDOCIPHER_API_SECRET =
STRIPE_PUBLISHABLE_KEY =
STRIPE_SECRET_KEY =
```
Run the server:
```bash
pnpm run dev
```
The server should now be running at `http://localhost:8000`.
### 3️⃣ Set Up the Client
Open a new terminal and navigate to the client folder:
```bash
cd client
```
Install the dependencies:
```bash
pnpm install
```
Create a `.env` file in the client directory with the following details:
```env
NEXT_PUBLIC_SERVER_URI = "http://localhost:8000/api/v1"
NEXT_PUBLIC_SOCKET_SERVER_URI = "http://localhost:8000/"
GOOGLE_CLIENT_ID =
GOOGLE_CLIENT_SECRET =
GITHUB_CLIENT_ID =
GITHUB_CLIENT_SECRET =
SECRET =
# Stripe Backup and Passkey (Optional)
# STRIPE_BACKUP =
# STRIPE_PASSKEY =
```
Run the client:
```bash
pnpm run dev
```
The client should now be running at `http://localhost:3000`.
### 4️⃣ Access the Application
- Client: `http://localhost:3000`
- API: `http://localhost:8000/api/v1`
## 🌟 Folder Structure
Here’s an overview of the project structure:
```plaintext
learnifypro/
│
├── client/ # Frontend code (Next.js)
│ ├── src/
│ ├── public/
│ ├── .env.example
│ └── ...
│
├── server/ # Backend code (Node.js + Express)
│ ├── src/
│ ├── .env.example
│ └── ...
│
├── README.md # Documentation
└── ...
```
## 🧩 Integrations
LearnifyPro integrates seamlessly with popular services:
- **Stripe**: Payment gateway for subscriptions.
- **Socket.IO**: Real-time chat and notifications.
- **MongoDB**: NoSQL database for data management.
- **Cloudinary**: Media storage and optimization.
## **🚨 Note on Backend Deployment**
**The backend is deployed using Render's free tier for hosting**, which results in a delay of **3-5 minutes** for the initial load. This is because the server may go idle when not in use, and it takes some time to "wake up" when a request is sent. Please be patient while the server initializes.
## 🤝 Contributing
We welcome contributions to LearnifyPro! 🎉
To get started:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes and commit them:
```bash
git commit -m "Add your meaningful commit message"
```
4. Push to your fork and submit a Pull Request.
## 📧 Contact
If you have questions, feel free to reach out:
- **Name**: Prem Shinde
- **Email**: [email protected]
- **GitHub**: [PremShinde-2013](https://github.com/PremShinde-2013)
- **Portfolio**: [premshindedev.vercel.app](https://premshindedev.vercel.app)
Happy Coding! 🎉🚀
---