OneEducationalWebsiteForAll

If I have to describe my project , in simple words , it would be an educational website , but not just that , it would be the best website , a person or organisation can ever ask for . It will have many features including VideoLectures , Theory/Notes , TestSeries , DataAnalysis of results , Blogs to motivate or for Guidance , Attendance System and many more features. We would also deploy it , so that it can be a real-time working project and it would help everyone to gain a lot of experience and learning curve for this project would also be great . It would also have the best design which would make it interactive as well as attractive .
This Project would start from scratch , so that each and every individual can participate and contribute and learn to the maximum extent .
If a contributor , had contributed to this project and had put efforts in the same , it would also help them for their freelancing career , because similar websites are asked to build on the freelancing websites.

Tech Stack

Setup and Installation

A common issue many people may face while setting up the project: Running npm install(or npm i) throws these errors -

This occurs due to the mismatch in the versions of node and npm installed on your local machine and the ones used in the project.

Solution

Update NodeJS : Download the latest version of Node from it's official website -

https://nodejs.org/en/

This would overwrite the previous outdated version.

Update NPM : Open your terminal, type the following command and hit enter -

 npm install npm@latest -g

This would update npm to it's latest version available.

And you're done! Run the following commands in the project directory to set up the project.

npm install

npm start

Contribution Guidelines 🏗

Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and improve it further

To start contributing, follow the below guidelines:

🌟. Star🌟 the project to bookmark and appreciate the work.

0. Take a look at the existing issues or create your own issues. Wait for the Issue to be assigned to you after which you can start working on it.

1. Fork this repository.

2. Clone your forked copy of the project.

git clone --depth 1 https://github.com/<your_user_name>/OneEducationalWebsiteForAll.git

3. Navigate to the project directory 📁 .

cd OneEducationalWebsiteForAll

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/Akshima-Ghai/OneEducationalWebsiteForAll.git

5.* Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream master

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.

13. Add an appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15. Voila ❗ You have made a PR to the Akshima-Ghai/OneEducationalWebsiteForAll project 💥 . Sit back patiently and relax while the project maintainers review your PR. Please understand, at times the time taken to review a PR can vary from a few hours to a few days.

aviral14112001 / oneeducationalwebsiteforall Goto Github PK