Skip to content

Setup.md

Latest commit

 

History

History
60 lines (43 loc) · 2.13 KB

Setup.md

File metadata and controls

60 lines (43 loc) · 2.13 KB

React app setup guidelines 🚀

Hello contributor , i want you to stick to the below listed Setup guidelines to successfully setup the react app in your local system and get started with developing!!


  • Fork the repo to your account.

  • git clone to clone the repo

  • Now you have the repo in your local storage

  • You can access the client folder to get the frontend

  • Next to setup the react app npm install

  • Once the node modules and other stuffs are installed , npm start to start the app in http://localhost:3000/

  • You can access the server 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 small components like Navbar, Footer in src\components folder

  • Keep big Pages like Login page, home page in the src\pages folder

  • We have used Bootsrap 5.0 for styling , css files are available in src\styles

  • You are also allowed to use GOOGLE FONTS for same fonts as of figma files.

  • 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 here

  • 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 itsroy69-doctalk BRANCH !!

  • Once done create a Pull Request and wait for the mentor to review.

  • Don't forget to attach Screenshots, Proper Description and Issue Number in the Pull request


Docker setup guidelines 🚀

Prerequisite

  • Install Docker Desktop

Step 1 - Clone the repository

 git clone https://github.com/ItsRoy69/DocTalk

Step 2 - Change directory to DocTalk

 cd DocTalk

Step 3 - Run docker compose file

docker-compose up -d --build

Step 4 - Open in browser

visit localhost:3000 to run the app