Setup.md

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 main folder to get the webapp access

• Next to setup the react app npm install

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

• Make changes according to the Tasks assigned to you

• Maintain the folder structure , keep small components like Navbar, Footer which stays in every page in src\constants folder

• keep other small components which stays in every page in src\components folder

• Keep big Pages like Auth page, Home page in the src\pages folder

• Styles of respective pages should be included in respective folder.

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

• Once you are done with the changes , git pull to pull the latest version of the code

• git add . to stage for commits

• git commit -s -m "message" for commiting the code.

• REMEMBER --> YOU NEED TO PULL REQ ON main 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 NODE.JS v20

Step 1 - Clone the repository

 git clone https://github.com/WikiPortal/DoodleCollab

Step 2 - install the node modules

npm install

Step 3 - Run the app

npm run dev

Step 4 - Open in browser

visit localhost:5173 to run the app