Outreachy Winter 2022: Applicants tasks/contributions: Creating/planning MOOCs

BatoolMM commented 2 years ago

🎊 Welcome Outreachy 2022 Contributors! We're excited that you're here 🎉

This ticket will serve as the central point tracking the contributions of perspective Outreachy (Winter 2022 cohort) applicants.

Outreachy provides paid remote, three-month internships to support diversity in Free and Open Source Software (FOSS). For more information about what Outreachy is, follow this link.

Outreachy internships are:

💵 Paid - $7,000 USD total internship stipend

🌍 Remote - both interns and mentors work remotely

🕰 3 months - internships run May to August.

For those interested, this process is described here.

We ask all outreachy candidates to work on a minimum of 3 projects simultaneously so that they are not completely relying on their selection in OSCSA if we end up not selecting them!

Summary

Open Science community Saudi Arabia (OSCSA) was established in line with Saudi Arabia’s Vision 2030, which focuses on installing values, enhancing knowledge and improving equal access to education. It aims to provide a place where newcomers and experienced peers interact, inspire each other to embed open science practices and values in their workflows and provide feedback on policies, infrastructures and support services. Our community is part of the International Network of Open Science & Scholarship Communities (INOSC).

Open Science has developed materials of its own and collaborated with other communities to the ruse and localise their materials, but none of it is incorporated within the website.

How to start?

Join OSCSA community here
Go through the code of conduct.

Submission

Submit a new issue with PR. Use our template for both issue and PR
Explain in your PR what you did and what do you think needs improving?

Tasks for Intern Selection:

Task 1, 2 and 3 are completed in this issue Open-Science-Community-Saudi-Arabia/OSCSA_Website#12

Task 4

Open Science Community would like to develop Massive Open Online Courses (MOOCs), which are free online courses available for anyone to enrol. 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, view videos and written materials as lessons. This will be similar to Udemy and other platforms for MOOCs. Your task is to create a demo of the website using any backend technology. You don't have to create the next Udemy, only a demo and showing how you can implement functionality in the website.

Don't use Moodle
Arabic alignment should work well
The participants should be able to type code in some of the exercises.
If you can't provide all functionality, provide your plan of how you can implement them.
The PR won't be merged, multiple applications are allowed with this task only!

You need to create an issue outlining your plan and how you attempted to take the 1st step in creating this MOOCs platform.

Task 5

This is described in Open-Science-Community-Saudi-Arabia/OSCSA-en-blog#6

Task 6

This is described in Open-Science-Community-Saudi-Arabia/OSCSA-en-blog#6

Meetings

We will lead an online video call (on Zoom) to answer any questions you have. This will be on Tuesday, the 18th of October, at 12:10 pm UTC!

The link for Zoom Meeting https://liverpool-ac-uk.zoom.us/j/93627968243?pwd=OVh5d1IreFRnOVRpNDVXMWRwMmlmZz09

Assessing Candidates

Candidate should be comfortable collaborating through GitHub
Your UI/UX design
Candidates should also be comfortable using HTML/CSS/JS.
Their insights about how they think the website can be improved!
Candidate should be comfortable opening issues and PR with elaborate descriptions.

Communication

Maintainers will answer your questions under the issue or Github Discussion from 10:00am - 4:00pm UTC. Please avoid communicating through emails unless it is necessary.

Lilianada commented 2 years ago

Thank you @BatoolMM I have gone through #5 but it is for Backend and I am a Frontend developer.

RealRichi3 commented 2 years ago

@Lilianada check #10

RealRichi3 commented 2 years ago

@BatoolMM , for the backend API, i still have many features to implement, and i might not be able to wrap it up before the deadline for Outreachy application. Is it okay if i continue working on it even after the contribution phase?

BatoolMM commented 2 years ago

Hi @RealRichi3, of course, you are a member of OSCSA, and you are very welcome to continue to work on any of these issues after the contribution phase. My I suggest that you attempt to deploy what you have developed so far in free service (e.g. Netlify) and focus on submitting a PR for brief documentation for future contributors, so it is easier for new contributors to contribute to your work.

Also, I would like to highlight that regardless of the internship in Outreachy, all contributors are acknowledged in the GitHub README and any talk presented by community members. OSCSA is alos happy to :

Add a recommendation on the applicant's LinkedIn profile
Endorse you for skills on LinkedIn
Coaching you on how to highlight their contributions on your resume
We also happy to provide a reference or recommendation letter

Thank you again for all your wonderful contribution so far 🌷!

RealRichi3 commented 2 years ago

Thanks @BatoolMM, i appreciate that

RealRichi3 commented 2 years ago

@BatoolMM , Please, the timeline of work they are referring to here, does it include everything we were to work on during this contribution phase, or is it just for the future internship phase. If it's for the internship phase, please how can i get it?

sandygudie commented 2 years ago

@RealRichi3 see this discussion https://github.com/orgs/Open-Science-Community-Saudi-Arabia/discussions/52?#discussioncomment-4018202

RealRichi3 commented 2 years ago

@sandygudie thanks

BatoolMM commented 2 years ago

Also, thank you all for your contributions so far. Don't worry if your PR isn't merged yet, still don't forget to add your contributions to Outreachy. In terms of the timeline, feel free to submit your your own timeline. This will not be taken into account during the selection process in OSCSA.

Outside Outreachy, we are happy for your continued involvement in the Community and you are very welcome to continue to work on any of these issues after the contribution phase 🌷

@sandygudie and @RealRichi3 let me know if you managed to deploy a test of the MOOCs?

RealRichi3 commented 2 years ago

@BatoolMM I'll deploy the API for test soon, still working on some endpoints

RealRichi3 commented 2 years ago

@BatoolMM i was thinking of deploying to Google cloud platform, there are other options like heroku and render but they are a bit slow, since it's for testing is it okay if i use my personal google account to deploy it on GCP?

sandygudie commented 2 years ago

@RealRichi3 I could start testing with postman, do you have a documentation for the endpoint? I could set that up too

RealRichi3 commented 2 years ago

@sandygudie, only the API doc for authentication is ready, buy @anslemkelechi is working on the documentation for other endpoints

sandygudie commented 2 years ago

Alright @RealRichi3 @BatoolMM some PR for the frontend development are yet to be merged, I dropped a comment here https://github.com/Open-Science-Community-Saudi-Arabia/MOOCs/pull/90#issuecomment-1299810264

RealRichi3 commented 2 years ago

@BatoolMM i have deployed the API for testing. I created an issue for it here #113, here's the link https://moocs-test.onrender.com

RealRichi3 commented 2 years ago

@BatoolMM, you said something about the for the API plan description, i think you meant i should explain how i intend to implement all the features for the API for MOOCs platform, i have one question tho.

Should i create only one issue for the description?,

I already started creating separate issues to explain how i intend to implement each feature. This would be one issue per feature. After that, i'll reference all the issues in a parent issue.

One issue for Authentication is already here #116.

What do you think?

BatoolMM commented 2 years ago

@sandygudie Thank you for the note, I merged the PR. @RealRichi3 Thank you for creating the issue about the API plan description. It looks good to me but what I meant is a documentation for the future developers/contributors in CONTRIBUTING.md showing the structure of the files/scripts, what each one suppose to serve and how new contributors should navigate the codebase. Let me know if this is not clear!

RealRichi3 commented 2 years ago

Thanks @BatoolMM , just to be clear, do you mean i should explain how the project is structured in terms of how the folders are organized and also explain the purpose of the folders. For example utils i should say it's used to store files which their functions that are frequently imported Then outline how contributions should be made and what areas contributions should be made to.

Is this what you mean?

sandygudie commented 2 years ago

@BatoolMM Thank you for the merge privilege.🙌

@realRichi3 my thoughts Add a CONTRIBUTING.md file just like a README.md file to the backend folder, the CONTRIBUTING.md file would explain how to

run/ set up the backend project,
the project structure,
explain each file and what it does,
the tools/technology used in the project,
how to contribute to the project(cloning, issues, creating a branch, making a PR etc)
existing APIs
you can add other details you feel is relevant to the project

you can get some ideas from here https://github.com/Open-Science-Community-Saudi-Arabia/MOOCs/tree/dev_team2#readme https://github.com/atom/atom/blob/master/CONTRIBUTING.md

RealRichi3 commented 2 years ago

Thanks @sandygudie, i get it now

sandygudie commented 2 years ago

@BatoolMM @RealRichi3 The frontend deployment link :https://oscsa-moocs.netlify.app/

BatoolMM commented 2 years ago

This is fantastic, thank you @sandygudie. Can we link both the backend and front end and deploy them in the same app? right now, the backend doesn't seem to be working at all.

sandygudie commented 2 years ago

i think the backend has to be hosted on a separate server(like hosting platform such as Heroku) and then consumed as APIs on the frontend, @RealRichi3 can the frontend consume endpoints directly from the backend?

RealRichi3 commented 2 years ago

The backend has been hosted separately on render, you only need to read the documentation on how to consume the endpoints

RealRichi3 commented 2 years ago

I already hosted the Backend API on render, and it works fine when making requests from postman, You can import the postman JSON from here then read the documentation https://github.com/Open-Science-Community-Saudi-Arabia/MOOCs/blob/560c2941548f49b11196c3ee4fe70bdd81357664/backend_API/src/API%20doc/MOOCs.postman_collection.json

RealRichi3 commented 2 years ago

@BatoolMM @sandygudie, here's a sample request i sent to the backend API using postman.

it works fine

RealRichi3 commented 2 years ago

@sandygudie i just published the API doc here, please check it out https://documenter.getpostman.com/view/20633788/2s8YemuZwv

sandygudie commented 2 years ago

Awesome @RealRichi3 i will a bit of testing from my end

RealRichi3 commented 2 years ago

@BatoolMM considering #2 is the only significant proposal for the MOOC platform demo, does this mean it won't remain at just being a demo? Then you can review and more contributions will be made to make it full scale

RealRichi3 commented 2 years ago

@sandygudie, what's the update on linking the front end to the endpoints for authentication, have you been able to do it?

sandygudie commented 1 year ago

i will get on it, I wanted to complete the landing page and relevant setup first

RealRichi3 commented 1 year ago

@sandygudie Alright then, the backend API is complete, once you're ready to start using the other endpoints, let me know so i can update the API doc

anslemkelechi commented 1 year ago

@sandygudie Alright then, the backend API is complete, once you're ready to start using the other endpoints, let me know so i can update the API doc

@RealRichi3

Can you share access to the API doc, so I can contribute also.

RealRichi3 commented 1 year ago

@anslemkelechi
What's your postman email address?

anslemkelechi commented 1 year ago

@anslemkelechi

What's your postman email address?

Hi @RealRichi3 It's kelechi.webdev@gmail.com

RealRichi3 commented 1 year ago

@anslemkelechi alright, i'll send you an invite

RealRichi3 commented 1 year ago

@anslemkelechi i just sent you an invite, please check your mail

anslemkelechi commented 1 year ago

@anslemkelechi i just sent you an invite, please check your mail

Thanks @anslemkelechi I got it.

RealRichi3 commented 1 year ago

@BatoolMM, thanks for the opportunity to contribute to this project. I have a question, for the internship programme, aside the contributions is there anything else you'd like us to do?

BatoolMM commented 1 year ago

Thank you all for your hard work and amazing contributions 🙇🏽 . The Community coordinator will follow up with an email for all of you and congratulations to the selected interns 🌷

@RealRichi3 Yes, we will follow up with more details about the tasks you will complete in the internship.

Thesaleem commented 1 year ago

Congratulations to @sandygudie and @RealRichi3. Very well deserved, I know you guys are going to deliver excellently. Thanks to @BatoolMM for the opportunity to contribute to this project. I hope to make more significant contributions. Welldone guys. 💪🏾💪🏾

RealRichi3 commented 1 year ago

Alright, @BatoolMM

RealRichi3 commented 1 year ago

Thanks @Thesaleem

sandygudie commented 1 year ago

Congratulations to @sandygudie and @RealRichi3. Very well deserved, I know you guys are going to deliver excellently. Thanks to @BatoolMM for the opportunity to contribute to this project. I hope to make more significant contributions. Welldone guys. 💪🏾💪🏾

Thank you🙌

RealRichi3 commented 1 year ago

@sandygudie, i have updated the auth flow for password reset, i also added another route to get logged in users data. You can check the API documentation for the reset update. Here's the PR #133

Please test and give me feedback

sandygudie commented 1 year ago

@sandygudie, i have updated the auth flow for password reset, i also added another route to get logged in users data. You can check the API documentation for the reset update. Here's the PR #133

Please test and give me feedback

Alright, I will look into it

Open-Science-Community-Saudi-Arabia / MOOCs