[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

[RealRichi3]

@oEbuka when you're done with the models, you can claim another task? Ensure to tag me in the PR so I'll review

[oEbuka]

@oEbuka when you're done with the models, you can claim another task? Ensure to tag me in the PR so I'll review

Thanks a lot, I appreciate.

[RealRichi3]

@oEbuka when you're done with the models for the course, I'd like to work on the create/upload course feature

[oEbuka]

@oEbuka when you're done with the models for the course, I'd like to work on the create/upload course feature

It seems I can't tag you on my PR. Only the members of OSCSA.

[oEbuka]

@RealRichi3 I'd like to be assigned to the update and delete course feature when you are done.

[RealRichi3]

Then reference this issue, the PR will appear here

[oEbuka]

Then reference this issue, the PR will appear here

done

[RealRichi3]

When you're done with your current task, you can claim the next one

[RealRichi3]

@oEbuka Please edit the title so it'll match this format [Date] Backend API [feat] - your title

[RealRichi3]

@anslemkelechi
In my opinion, i think for each task it'll be better to create only one sub issue of this main issue, chaining too many issues might make it difficult to track progress. What do you think?

[anslemkelechi]

@anslemkelechi In my opinion, i think for each task it'll be better to create only one sub issue of this main issue, chaining too many issues might make it difficult to track progress. What do you think?

It's okay that way. I will edit my issue to reflect the sub-issue I am working on exactly

[anslemkelechi]

@RealRichi3 Hi, I would love to know why you created a special model for passwords and connected it to the user model with virtual properties, why do we not have everything pertaining to the user kept directly in the user model to avoid unnecessary complexities? I would love to know why you did it this way though.

[Amidsts]

pls i need the figma design for this project

[Amidsts]

@RealRichi3 @BatoolMM the dev_team2 branch I cloned doesnt have backend folder like it does on github, what do you think the problem is ?

[anslemkelechi]

@RealRichi3 @BatoolMM the dev_team2 branch I cloned doesnt have backend folder like it does on github, what do you think the problem is ?

That's because by default github will clone the main branch, you will need to specify the branch you want to clone. Use this instead $ git clone -b dev_team2

Clear enough?

[RealRichi3]

@RealRichi3 Hi, I would love to know why you created a special model for passwords and connected it to the user model with virtual properties, why do we not have everything pertaining to the user kept directly in the user model to avoid unnecessary complexities? I would love to know why you did it this way though.

I did it that way so that when fetching users data, we won't mistakenly add the users password. I just don't want to take any chances

[RealRichi3]

@anslemkelechi In my opinion, i think for each task it'll be better to create only one sub issue of this main issue, chaining too many issues might make it difficult to track progress. What do you think?

It's okay that way. I will edit my issue to reflect the sub-issue I am working on exactly

Perfect, please one task at a time tho, so others can contribute

[RealRichi3]

@RealRichi3 @BatoolMM the dev_team2 branch I cloned doesnt have backend folder like it does on github, what do you think the problem is ? I don't have it You can ask in the front end issue here #10 they'll be in the best position to answer

[anslemkelechi]

@RealRichi3 Hi, I would love to know why you created a special model for passwords and connected it to the user model with virtual properties, why do we not have everything pertaining to the user kept directly in the user model to avoid unnecessary complexities? I would love to know why you did it this way though.

I did it that way so that when fetching users data, we won't mistakenly add the users password. I just don't want to take any chances

It's was kind of complex though, I did some refactoring. We can handle the issue of fetching user data by setting "select property to false" in the schema. When I make the PR you would be able to compare.

[RealRichi3]

Alright then

[RealRichi3]

We'll need an authentication middleware for post login activities, I'd like to work on it, was supposed to work on the course create feature but i'll leave that till @oEbuka completes the model

[RealRichi3]

I think it'll be nice to add more features to improve the API, but maybe after we're done with these tasks. What do you guys think

[RealRichi3]

@anslemkelechi for the login control, will you issue something like a JWT token after successful login, i need to know so i'll know how to implement the authentication middleware

[oEbuka]

We'll need an authentication middleware for post login activities, I'd like to work on it, was supposed to work on the course create feature but i'll leave that till @oEbuka completes the model

you can merge now.

[anslemkelechi]

@anslemkelechi for the login control, will you issue something like a JWT token after successful login, i need to know so i'll know how to implement the authentication middleware

Yes @RealRichi3, I would!

[anslemkelechi]

Hi @RealRichi3, PR #38 for the authentication feature has been made, please review and merge.

[RealRichi3]

Alright

[RealRichi3]

We'll need an authentication middleware for post login activities, I'd like to work on it, was supposed to work on the course create feature but i'll leave that till @oEbuka completes the model

you can merge now.

Alright

[anslemkelechi]

I would love to work on the task of email verification and password reset

[anslemkelechi]

@RealRichi3 Please can you update this issue, so it can reflect the tasks that has be done.

[RealRichi3]

@anslemkelechi alright

[RealRichi3]

@anslemkelechi you'll have to pick only one task at a time

[RealRichi3]

Thanks for the contribution so far tho

[anslemkelechi]

@anslemkelechi you'll have to pick only one task at a time

I actually selected it that way because the tasks are related to each other, anyway I would rename my issue and stick with one at first.

[anslemkelechi]

I would work on the password reset functionality #42 @RealRichi3

[RealRichi3]

Oh, alright then

[RealRichi3]

I'd like to work on the router level permission middleware

[oEbuka]

@RealRichi3 I would like to work on Create/Upload Course.

[RealRichi3]

@RealRichi3 I would like to work on Create/Upload Course.

Sure, once @BatoolMM merges your inital PR you can start working on it, i'll reserve it for you tho

[RealRichi3]

btw, @BatoolMM @anslemkelechi @oEbuka are there other features you think would be nice to add to the API, aside what's already outlined

[RealRichi3]

I will work on the Google signin feature

[Amidsts]

@RealRichi3 @BatoolMM why are the pr not merged? I am working on course or video API, but I noticed someone has created a model for it, but it hasn't been merged.

@oEbuka pls can you stop working on video/course related ? I already created an issue on it, and I am working on it

[RealRichi3]

@ORIYOMI289 before creating a sub issue for any task, please claim it here first so we all know you're the one handling it. Currently @oEbuka already claimed the create/upload task, you can pick any other one.

[RealRichi3]

@ORIYOMI289 it is one task at a time, so others can contribute

[Tammy-Ajoko]

Is anyone working on the front end part of this, I would like to work on it @RealRichi3

[RealRichi3]

@Tammy-Ajoko yes, you can check here #10

[RealRichi3]

I'd work on unit tests, will be updated with each new feature

[anslemkelechi]

@oEbuka Hi, I would love to know if you are done with the create & updating course model, as i would love to work on the get access to all course and all data for a particular course.

[Amidsts]

@anslemkelechi @oEbuka I am already workin on delete course and get access to all course.

between ebuka. I created an issue on create course here #8 i guess it wasn't assigned to me. besides I am already working on it

[Amidsts]

@anslemkelechi @BatoolMM @oEbuka @RealRichi3 I am working on get all courses and delete course by admin #51 , pls assign the issue to me