Course app

Prerequisites

Make sure you have the following installed on your system:

• Node.js
• PostgreSQL
• redis

Installation

1. Clone the repository:

git clone https://github.com/iam-abin/Zebronet.git

2. Navigate to the project directory:

cd Zebronet

3. Install the dependencies:

npm install 

4. Set up the required environment variables. Rename the .env.example file to .env and provide the necessary values for your environment.

5. Start server (Running the app):

 npm run dev

Start with these steps

1. Signup a user with userName, email, password , using signup route.
   POST http://localhost:8000/api/v1/auth/signup eg -

{
    "name":"arun",
    "email":"arun@gmail.com",
    "password":"arun"
}

2. Signin using the email and password to generate JWT access token, using signin route.
3. POST http://localhost:8000/api/v1/auth/signin eg -

{
    "email":"arun@gmail.com",
    "password":"arun"
}

3. Then do other tasks using api endpoints

Api documentation

courseApp documentation

Api Endpoints

User

POST http://localhost:8000/api/v1/auth/signup - for user signup('user' who create teams ans tasks)
POST http://localhost:8000/api/v1/auth/signin- for user signup('user' who create teams ans tasks)

Course

POST http://localhost:8000/api/v1/course - to create a course
GET http://localhost:8000/api/v1/course/1 - to get a course using courseId with associated lessons
GET http://localhost:8000/api/v1/course/Btech Mec - to search a course using course name
PATCH http://localhost:8000/api/v1/course/1 - to update a course using courseId
DELETE http://localhost:8000/api/v1/course/1- to delete a course using courseId

Lesson

POST http://localhost:8000/api/v1/lesson - to create a lesson
GET http://localhost:8000/api/v1/lesson/1 - to get a lesson using lessonId
PATCH http://localhost:8000/api/v1/lesson/1 - to update a lesson using lessonId
DELETE http://localhost:8000/api/v1/lesson/1- to delete a lesson using lessonId