OSCSA

Massive Open Online Courses (MOOCs) for Open Science in Arabic

Massive Open Online Courses (MOOCs) for Open Science in Arabic that include videos, MCQ questions and written resources!

Explore the docs »

View Demo · Report Bug · Request Feature

Deployment

Frontend: https://oscsa-moocs.netlify.app/

Technologies

Frontend Technologies

Technology	Version	Use
Prettier	v2.7.1	Code Formatting
React	v18.2.0	Frontend Framework
NodeJs	v14	Environment
EsLint	v8.2.0	Code Linting
Vite	v2.6.8	Code Bundler

Backend Technologies

Technology	Version	Use
NodeJS	v4.3	Backend Environment
ExpressJS	v3.10	Framework for building APIs
MongoDB	-	Non-Relational Database

Contributing 💕

• If you like it, leave your star in this project 🌟
• If you would like to complain/suggest/contribute to this project, feel free to open a issue 💟
• Please follow our contributing guidelines.
• This is the guide to how the UI Design should look when implementing any frontend pages. Click this link to see the figma design

Getting Started

Environment Setup

• Make sure you have nodejs installed by running the following command:

node -v

• If the output is not the version of your nodejs installation, install nodejs from here

Things to note

• Linting has been set up for staged commits in the repository.
• We're using eslint for js linting, and prettier for code formating.
• Please make it a point to install eslint and prettier plugins on vscode to aid in your coding process.
• Your code has to be properly formatted and have the correct syntax for you to be able to commit your changes.
• Make sure you attend to all warnings and errors before you commit your code

Setting up the Frontend

• Open Git Bash terminal inside root project folder
• cd into the frontend folder by typing

cd Frontend

• After ensuring you've installed nodejs install yarn.
• To install dependencies, run the following command:

yarn install

STARTING THE SERVER

• To start the whole application server

yarn dev

• Open http://localhost:5173 with your browser to see the result.
• You're all set. Happy coding😁

Creating a production building

yarn build

Checking formatting of whole project

• Run this script to check if all files meet prettier standard rules of formatting

yarn format:check

• Run this script to fix all auto-fixable formatting errors in the whole project

yarn format:fix

Checking code syntax is in line with eslint rules

• Run this script to check if all files meet eslint standard rules of code sytax

yarn lint:check

• Run this script to fix all auto-fixable syntax errors in the whole project

yarn lint:fix

Things to note as you contribute

• Any page you code has to be responsive.
• Write clear and concise commit messages.
• Always run yarn after pulling code from the upstream repository.
• Always, Always make pull requests to the dev_team2 branch, not the main branch. All pull requests to the main branch will not be merged.
• Please, always test your code and make sure it works correctly before making a pull request
• Run prettier --check "input name of file here" to check if your code is well formatted before you commit
• Run eslint input name of file here --color to check if the files you edited con form to the standards required for this project

Setting up Backend

Instructions on how to run the backend server:

• Open Git Bash terminal inside root project folder
• cd into the backend folder by typing

cd backend_API

• To install dependencies, run the following command:

npm install

• create a .env file in the project folder with the MONGO_URI, PORT variables

STARTING THE SERVER

• To start the whole application server

npm run dev

• Open your browser on localhost with the port you specified to see the result.
• You're all set and ready to code😁

License

This work is licensed under a Creative Commons Attribution 4.0 International License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Orofin Adedamola A. 🚇 🎨	Richie 🚇 🤔 👀	Goodnews Sandy 👀 🚇 🧑‍🏫	Wahab Mufidat 🎨	Kelechi Okoronkwo 🚇	Obiora Ebuka 🚇	Okereke Chinweotito ⚠️ 🚇
Amin Musah Ahmed 🐛	Juliana Sau 🚇 🤔	JewelCodes 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!