[12/10/2022]: BACKEND DEVELOPMENT for OSCSA MOOCs platform

[RealRichi3]

Description

Open Science Community would like to develop Massive Open Online Courses (MOOCs), which are free online courses available for anyone to enroll in. We have developed our own materials and will also reuse materials from Open Life Sciences and Turing Way. In order to do that, we need to develop a platform where a participant can log in, and view videos and written materials as lessons. This will be similar to Udemy and other platforms for MOOCs. Your task is to create a backend API of the website using any backend technology.

Technology

• Node JS
• Express JS
• MongoDB
• Cloudinary

For this we would create a MVC NodeJS application

PROJECT REQUIREMENTS

• User should be able to signup, verify email address after signup, login, reset password, update profile data
• User can get all the available courses
• User should have a history of all the courses they watched
• User can update profile data, i.e name, password, (excluding email address)
• Admin can carry out CRUD operations for courses , i.e, Upload or create course, get list of courses/videos, update course/video details and delete course/video.

TASKS

API Description

• [x] Authentication feature description
• Issue - #116
• [ ] Course feature description
• Issue -
• [ ] Exercise feature description
• Issue -
• [ ] Videos feature description
• Issue -

Main

• [x] Setup project structure
• Issue - #13
• PR - #14
• [x] Outline templates for pull requests and issues.
• PR - #14

Models

• [x] Database model for users and admin and passwords
• Issue - #30
• PR - #32
• [x] Database model for courses/videos
• Issue - #35
• PR - #25
• [x] Database model for exercises in each course
• Issue - #93
• PR - #94

Middlewares

• [x] Asynchronous function wrappers -(abstracts trycatch block)
• Issue - #33
• PR - #34
• [x] Error handler middleware
• Issue - #33
• PR - #34
• [x] Authentication middleware
• Issue - #41
• PR - #44
• [x] Permissions router middleware
• Issue - #45
• PR - #46

Utilities

• [x] Mailer for sending email

FEATURES

Authentication feature

• [x] Signup
• Issue - #7
• PR - #38
• [x] Email verification
• Issue - #91
• PR - #92
• [x] Login
• Issue - #7
• PR - #38
• [x] Password reset
• Issue - #42
• PR - #47
• [x] Social signin/signup with Google
• Issue - #48
• PR - #49

#

Each course should have multiple videos Each course should have multiple exercises Each exercise should have multiple questions

Course/Video feature

• [x] Create Course (restricted to admin)
• Issue - #86
• PR - #89
• [x] Delete course (restricted to admin)
• Issue - #51
• PR - #62
• [x] Get all data for particular course (should include exercises if any)
• Issue - #102
• PR - #103
• [x] Get all available courses
• Issue - #51
• PR - #62
• [x] Update course details (restricted to admin)
• Issue - #95
• PR - #97
• [x] CRUD operations for videos
• Issue - #99
• PR - #100
• [x] Enroll course feature @RealRichi3
• Issue - #107
• PR - #110

Exercises and Questions

• [x] CRUD operations for Questions
• Issue - #98
• PR - #106
• [x] CRUD operations for Exercises
• Issue - #101
• PR - #104 #

CI/CD and Tests

• [ ] Create unit tests
• • [x] Auth tests (signup, login, verify email, password reset, basicAuth middleware)
    • Issue - #50
    • PR - #71
    • PR - #81
• • [ ] Permissions test (for express router permission middleware)
• • [ ] Course routes test
• [ ] CI/CD to automate tests for each pull request
• [ ] API documentation @anslemkelechi
• Issue - #105
• PR - #111

CONTRIBUTING

• If you want to work on any of these tasks, signify by leaving a comment, then you should create a sub issue for the task.
• For each sub issue for any task add a reference to this issue (ex: Sub issue for #5)
• When creating an issue for any of these tasks/features please add a description on the feature you intend to implement
• This issue is open to collaboration, your thoughts and suggestions are highly welcome. If you think any task is missing please comment below and it will be added
• All Pull requests relating to any task in this issue should be directed to the dev_team2 branch
• The dev_team2 branch will be used by both the Frontend contributors and Backend contributors
• All work for the Backend API should be done inside the /backend_API folder in dev_team2 branch

For pull request relating to any task in this issue the title should include [Date] BACKEND API [feature or bug] your title

Suggestions are highly welcomed

ALL MAJOR ANNOUNCEMENTS WILL BE MADE IN THE PARENT ISSUE #2

[BatoolMM]

@RealRichi3 Please don't close the issue if the PR is note reviewed and merged!

If you closed other issues, please re-open it!

[RealRichi3]

Alright, i haven't completed the content of the issue that's why, but i understand you perfectly well

[anslemkelechi]

Awesome @RealRichi3. Looking forward to collaborating here. I would love to work on the authentication for the API, which will include all you listed above.

[Amidsts]

8 I will love to work on this issue

[RealRichi3]

Awesome @RealRichi3. Looking forward to collaborating here. I would love to work on the authentication for the API, which will include all you listed above.

it'll be nice to pick one task so others can contribute

[RealRichi3]

Plus i would have to setup the project structure first, but for now we cant do any thing until @BatoolMM approves our request to create a development branch for the backend

[RealRichi3]

A dev branch has been created for development, i would create a folder backend to add all our code for the backend there

[oEbuka]

@RealRichi3 Now the dev branch has been created, what's next?

[anslemkelechi]

Awesome @RealRichi3. Looking forward to collaborating here. I would love to work on the authentication for the API, which will include all you listed above.

it'll be nice to pick one task so others can contribute

That wouldn't be an issue, if you want to contribute to #7, create a sub-issue from it and describe what you would be contributing, please add a reference to the parent issue #2

[anslemkelechi]

A dev branch has been created for development, i would create a folder backend to add all our code for the backend there

Please I believe we would be use MVC @RealRichi3

[RealRichi3]

Yea, i'm almost done with the project setup

[RealRichi3]

@RealRichi3 Now the dev branch has been created, what's next?

I would setup the project structure, once it's merged you all can make pull requests and claim any task

[RealRichi3]

I have set up the project structure, i'm waiting for @BatoolMM to merge into dev branch

[BatoolMM]

I commented in your PR, let me know if you need me to do anything else to help you!

[RealRichi3]

Thanks @BatoolMM

[oEbuka]

@RealRichi3 I am asking to be sure, your branch has not been merged yet right?

[RealRichi3]

@oEbuka Not yet, i will inform everyone when it's ready for development

[RealRichi3]

@oEbuka @anslemkelechi @ORIYOMI289 you all can start making contributions, the project structure has been added, we would be working with the dev_team2 branch

[anslemkelechi]

@oEbuka @anslemkelechi @ORIYOMI289 you all can start making contributions, the project structure has been added, we would be working with the dev_team2 branch

@RealRichi3 Thanks for the progress

[oEbuka]

@oEbuka @anslemkelechi @ORIYOMI289 you all can start making contributions, the project structure has been added, we would be working with the dev_team2 branch

Thanks

[Amidsts]

@RealRichi3 do we need to create our own branch when we want to push, or we should push directly to dev_team2 ?

[RealRichi3]

You should create a different branch, the make pull request from your branch to the dev_team2 branch?

[RealRichi3]

I would like to work on the Database Models for users and admin

[anslemkelechi]

I would like to work on the Database Models for users and admin

Hi @RealRichi3

Since you are working on the user model, probably I should pause till you are done before I work on the authentication since its based on the user model, or what do you think?

[RealRichi3]

True

[RealRichi3]

@anslemkelechi i just completed the user models including the models for password, once it's merged you can continue

[RealRichi3]

I had something in mind, for every new endpoint or feature created, we should create a unit test for it, so future updates won't break previous code

[anslemkelechi]

@RealRichi3 Okay, I will keep my head up, thanks.

[anslemkelechi]

I had something in mind, for every new endpoint or feature created, we should create a unit test for it, so future updates won't break previous code

Okay That's great, I would keep that in mind. Your model will reflect that right?

[RealRichi3]

@anslemkelechi the PR for the models has been merged, you can begin now, I would like to work on the course/videos features

[RealRichi3]

I had something in mind, for every new endpoint or feature created, we should create a unit test for it, so future updates won't break previous code

Okay That's great, I would keep that in mind. Your model will reflect that right?

I haven't added the test yet, only the models, i'll work on that later on

[RealRichi3]

For the authentication are you working on everything?

[RealRichi3]

And to implement permissions, i think it would cut accross all routes, it can be something like a router middle ware to verify if a user is allowed to access a specific route, what do you think?

[anslemkelechi]

And to implement permissions, i think it would cut accross all routes, it can be something like a router middle ware to verify if a user is allowed to access a specific route, what do you thing?

@RealRichi3

That's exactly what I have in mind, a router middleware to protect all restricted routes.

[anslemkelechi]

And to implement permissions, i think it would cut accross all routes, it can be something like a router middle ware to verify if a user is allowed to access a specific route, what do you thing?

@RealRichi3

That's exactly what I have in mind, a router middleware to protect all restricted routes.

[anslemkelechi]

For the authentication are you working on everything?

For now, I would, nobody has expressed a desire to work on other parts of it, I did ask that if anyone wants to contribute to it they can create a sub-issue out of this #7

[RealRichi3]

True, or better still, just work on one issue at a time, if you're done and no one has claimed the other task, you can continue

[RealRichi3]

You can pick the task to implement permissions

[RealRichi3]

I would like to work on the async_wrappers and error handlers, can be used to abstract trycatch in all controllers

[anslemkelechi]

@RealRichi3 Okay, that would be fine, for now, I am working on the login and signup routes(Pending when your PR is merged for the user model), once I am done I can progress to another task on after the other.

[RealRichi3]

Alright, i'll add your name now

[oEbuka]

@RealRichi3 could you please check my PR, I worked on the DB models. Can you also assign me to the Course/Video feature tasks.

[RealRichi3]

Please if you want to work on any task, signify here first so i'll know who has claimed it

[RealRichi3]

@oEbuka You didn't signify here before hand that you'll work on the models, that's why i did it and it has been merged. You can pick any other task now, and i'll assign it to you.

Note, one task at a time not a full feature, so others will be able to contribute

[RealRichi3]

@anslemkelechi @oEbuka @ORIYOMI289 please when creating an issue for any of these tasks, reference this main issue so we can easily keep track of who has claimed a task and who's working on each task

[RealRichi3]

@oEbuka for the course and video feature, which particular task would you like to work on first, Is it creating the models? You can pick any so i'll assign it to you

[oEbuka]

@oEbuka You didn't signify here before hand that you'll work on the models, that's why i did it and it has been merged. You can pick any other task now, and i'll assign it to you.

Note, one task at a time not a full feature, so others will be able to contribute

My bad, my bad.

[oEbuka]

@oEbuka for the course and video feature, which particular task would you like to work on first, Is it creating the models? You can pick any so i'll assign it to you

Yes, I will like to be assigned that task.

[RealRichi3]

Alright @oEbuka, go ahead and create an issue for it

[RealRichi3]

Perfect