Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[New API] : E-learning Portal #66

Closed
1 task done
Puskar-Roy opened this issue May 11, 2024 · 3 comments · Fixed by #67
Closed
1 task done

[New API] : E-learning Portal #66

Puskar-Roy opened this issue May 11, 2024 · 3 comments · Fixed by #67
Assignees
Labels
awesome gssoc New label for GSSOC-24 level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS newapi Denotes the new api is there

Comments

@Puskar-Roy
Copy link
Contributor

Brief Description 🤓

E-learning Platform

TechStacks

Typescript, Node Js, Express Js, Prisma, PostgresSQL , Node Mailer, Cloudinary API

API End Points

1. (2FA) Authentication Routes

/api/v0.1/auth/login                                      POST               //for login
/api/v0.1/auth/register                                   POST               //for register
/api/v0.1/auth/forgot-password                            GET                //for forgot password
/api/v0.1/auth/reset-password                             POST               //for reset password 

2. Users Routes

/api/v0.1/users                                           GET                //for all users
/api/v0.1/users/:id                                       GET                //for a single user
/api/v0.1/users/:id                                       DELETE             //for delete a user
/api/v0.1/users/:id                                       PUT                //for update a user
/api/v0.1/users/:userId/enrollments                       GET                //for get all enrolled courses of a user

3. Course Routes

/api/v0.1/course                                          POST               //for create a course admin only
/api/v0.1/course?category=Python&level=Advance            GET                //for get all courses and you can add queries but its optional
/api/v0.1/course?category=JS&level=Beginner&page=1&pageLimit=3               //pagination with all the queries but its all optional
/api/v0.1/course/:id                                      PUT                //for update a course admin only
/api/v0.1/course/:id                                      DELETE             //for delete a course admin only
/api/v0.1/course/:id                                      GET                //for get a single course
/api/v0.1//course/trending                                GET                //for popular courses based on user enrollment
/api/v0.1/course/:courseId/enroll                         POST               //for enroll in a course
/api/v0.1/course/:courseId/leave                          DELETE             //for leave from a course
/api/v0.1/course/:courseId/reviews                        GET                //for getting all reviews of a course

4. Review Routes

/api/v0.1/review                                         POST               //for create a review
/api/v0.1/review/:id                                     DELETE             //for delete a review
/api/v0.1/review/:id                                     PUT                //for update a review

5. Profile Routes

/api/v0.1/users/:userId/profile                          POST               //for set profile and profile pic of a user
/api/v0.1/users/:userId/profile                          PUT                //for update profile and profile pic of a user

How will you develop it?🤩

I would develop it using the powers of Typescript and Express Js and my knowledge of APIs

Deployment

Yes

Select the open source program you are contributing to

Other

Code of Conduct

@dishamodi0910
Copy link
Owner

Greetings @Puskar-Roy🎀 ! , We are excited to have you dive into another issue with us!🚀
Your involvement in our project has been invaluable, and we're confident that your skills and insights will help us conquer this challenge😇.

Use command /gdsc to self assign the issue.

This issue represents an exciting opportunity for us to improve and enhance our project, and we are thrilled to have you on board.
We request you to follow CONTRIBUTING GUIDELINES.
Looking for your PR soon!
In case of any issues, you can contact us on Discord.❣️

@dishamodi0910 dishamodi0910 added awesome gssoc New label for GSSOC-24 newapi Denotes the new api is there labels May 11, 2024
@Puskar-Roy
Copy link
Contributor Author

/gdsc

@dishamodi0910 dishamodi0910 added the level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS label May 12, 2024
@dishamodi0910
Copy link
Owner

Hey @Puskar-Roy ! I wanted to inform you that we have closed issue.Thank you for your understanding, and we look forward to your continued engagement with our repository🤗.
In case of any issues, you can contact us on Discord.
Thank you! ❣️
Happy Coding! ✨
Will See you soon❣️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awesome gssoc New label for GSSOC-24 level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS newapi Denotes the new api is there
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants