GURU JI

About Us

We have created this platform to help students find the best tuition teachers in their city quite easily. You just have to enter the pin code of your city and we will show you the best teachers in your locality along with their teaching styles and their qualification from which you can select the best teacher for yourself.

Technology Stack

Getting Started

Want to contribute? Follow the steps below to set it up locally.

# Clone this repository
$ git clone https://github.com/your-username/MERN-Gurujii-dev.git

# Go into the repository
$ cd MERN-Gurujii-dev

# Install dependencies
$ yarn dep0
$ yarn dep1

# Run website
$ yarn dev

This should launch the website on localhost:3000.

We have used proxy so all the requests made to the backend from the frontend will be served at localhost:5000 at which our backend is running.

Note

• This project uses yarn to install the dependencies. Don't use npm install.

• To run the app locally, if you do not want to use the database at all, comment out the lines that reference the backend/config.js file:

  • Lines 9, 40 of backend/server.js
  • Line 3 of backend/controllers/user.controller.js

• For security reasons, we have made the MongoDb URI secure, by not adding a hardcoded username and password. For development purposes, you can install, MongoDB locally or use the online version. Also create your own backend/config.js file with proper credentials, following the format given in backend.config.example/js.

• There is a route that sends emails - Line 82 of backend/controllers/user.controller.js. Remember to replace the auth credentials with your own before testing the route.

• Remember not to push any personal data like mongo uri or mail credentials.

Contribution

Contributions are very welcome! See our CONTRIBUTING.md for more information.

Want to test your changes on mobile phone?

• To view on mobile, your laptop and mobile phone should be on the same network.
• Run ipconfig on the terminal, enter <ip4address>:3000 as URL on the mobile web browser.

Demo

Click Here to view the deployment!

Great! Now you are good to go. Open/pick an issue, discuss your idea, make the changes in your feature branch and create your first pull request in this repo.

Interesting?? Star this Repo

Open Source Program

This Project is a part of the following Open Source Programs

• GirlScript Summer of Code is a 3 month long Open Source program during summers conducted by the GirlScript Foundation which was started in 2018, with an aim to help beginners to get started with Open Source Development while encouraging diversity. Throughout the program, participants contribute to different projects under the guidance of experienced mentors. Top participants get exciting goodies and opportunities.

• GirlScript Summer of Code 2020 witnessed overwhelming participation and the 2021 edition will carry the legacy forward while promising to be even more impactful and grand.

Contributors:

Credits goes to these people:✨