Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 1.73 KB

contribution.md

File metadata and controls

30 lines (27 loc) · 1.73 KB

React app contribution guidelines 🚀


  • Fork the repo to your account.
  • Make a new branch.
  • git clone to clone the repo
  • You'll have the repo in your local storage
  • You can access the frontend folder to get the frontend
  • To setup the frontend npm install
  • Find all the urls with https://amused-cyan-shrimp.cyclic.app/ and replace it with http://localhost:5000/
  • Once the node modules and other stuffs are installed , npm start to start the app in http://localhost:3000/
  • You can access the backend folder to get the backend and start it with npm start in http://localhost:5000/
  • Make changes according to the Tasks assigned to you
  • Maintain the folder structure
  • Keep big Pages like Login page, home page in the src\pages folder
  • Keep the components/elements or custom hooks with multiple use in src\shared\ folder
  • Other extra Pictures, icons , svgs are to be kept in src\assets\
  • This website will be fully built in MERN Stack i.e MongoDB, ExpressJS, ReactJS, NodeJS.
  • For understanding of UI/UX check figma
  • Once you are done with the assigned task change the backend url http://localhost:5000/ and replace it with https://amused-cyan-shrimp.cyclic.app/
  • Once you are done with the changes , cd .. to come to the root folder
  • git pull to pull the latest version of the code
  • git add . to stage for commits
  • git commit -am "message" for commiting the code.
  • REMEMBER --> YOU NEED TO PULL REQ ON master BRANCH !!
  • Once done create a Pull Request and wait for the review.
  • Don't forget to attach Screenshots, Proper Description and Issue Number in the Pull request