Skip to main content

Welcome to SkillRise Documentation

Everything you need to set up, customize, and scale your AI-powered e-learning platform. Built for students, educators, and administrators.

Get StartedExplore API Reference
Rich Course Builder
Create engaging content
AI-Powered Learning
Smart chatbot & roadmaps
Community Features
Groups & discussions

Quick start

Get SkillRise running in under 10 minutes

1

Clone the repository

Clone the SkillRise repository from GitHub to your local machine.
git clone https://github.com/pv-pushkarverma/SkillRise.git
cd SkillRise
2

Configure environment variables

Set up your environment variables for both the client and server. You’ll need accounts with Clerk, Stripe, Cloudinary, and Groq.
# Copy example env files
cp server/.env.example server/.env
cp client/.env.example client/.env
Server (server/.env):
  • MONGODB_URI - MongoDB connection string
  • CLERK_SECRET_KEY - Clerk authentication secret
  • STRIPE_SECRET_KEY - Stripe payment processing
  • CLOUDINARY_NAME, CLOUDINARY_API_KEY, CLOUDINARY_SECRET_KEY - Media uploads
  • GROQ_CHATBOT_API_KEY - AI features
Client (client/.env):
  • VITE_CLERK_PUBLISHABLE_KEY - Clerk public key
  • VITE_STRIPE_PUBLISHABLE_KEY - Stripe public key
  • VITE_BACKEND_URL - Backend API URL (default: http://localhost:3000)
3

Install dependencies and start services

Install dependencies for both the client and server, then start the development servers.
# Install server dependencies
cd server && npm install

# Install client dependencies
cd ../client && npm install

# Start backend (in one terminal)
cd server && npm run server

# Start frontend (in another terminal)
cd client && npm run dev
4

Seed the database (optional)

Populate your database with sample courses, users, and content to explore features immediately.
cd server
npm run seed
The seeder creates demo educators, students, courses, quizzes, community groups, and posts. This is helpful for testing and development.

Explore by role

Find documentation tailored to your use case

For Students

Browse courses, enroll, track progress, and chat with AI learning assistants

For Educators

Create courses, manage content, track enrollments, and view revenue analytics

For Admins

Manage users, courses, purchases, and review educator applications

Core features

Powerful capabilities out of the box

AI-Powered Features

Groq-powered chatbot, personalized roadmaps, and auto-generated quizzes

Payment System

Secure Stripe integration with embedded checkout and webhook handling

Course Management

Multi-chapter courses with video player, progress tracking, and certificates

Community

Discussion groups, posts with upvotes, and threaded replies

Analytics

Time tracking, learning progress, and comprehensive dashboards

Authentication

Clerk-powered auth with multi-role system (students, educators, admins)

Integration guides

Connect with third-party services

Clerk Authentication

Set up user authentication with webhooks and role-based access control

View guide

Stripe Payments

Configure payment processing with embedded checkout and webhook verification

View guide

Groq AI

Enable AI chatbot, roadmap generation, and quiz creation with LLaMA models

View guide

Cloudinary

Configure media uploads for course thumbnails and content

View guide

Deployment & development

Deploy to production and contribute to the project

Docker Deployment

Deploy with Docker Compose or use pre-built images from Docker Hub

CI/CD Pipeline

Automated testing, linting, and deployment via GitHub Actions

Project Structure

Understand the codebase architecture and file organization

Contributing

Contribute to SkillRise with our development workflow

Ready to build your e-learning platform?

Follow our quickstart guide to get SkillRise running in minutes, or explore the API reference to integrate with your existing systems.

Start buildingView on GitHub