-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: itsroy69 <[email protected]>
- Loading branch information
Showing
11 changed files
with
118 additions
and
411 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,106 @@ | ||
| # 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!!** | ||
|
|
||
| <br/> | ||
|
|
||
| - `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** | ||
|
|
||
| <br/> | ||
|
|
||
|
|
||
| # 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` | ||
| # 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!!** | ||
|
|
||
| <br/> | ||
|
|
||
| - `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** | ||
|
|
||
| <br/> | ||
|
|
||
|
|
||
| ## Development Setup | ||
|
|
||
| Please follow the steps below to set up the development environment and contribute effectively. | ||
|
|
||
| ### 1. Clone the Repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/WikiPortal/DoodleCollab | ||
| cd DoodleCollab | ||
| ``` | ||
|
|
||
| ### 2. Install Dependencies | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 3. Start the Development Server | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Visit [http://localhost:5173](http://localhost:5173) in your browser to run the app. | ||
|
|
||
| --- | ||
|
|
||
| ## Server Setup | ||
|
|
||
| ### 1. Locate the server folder | ||
|
|
||
| ```bash | ||
| cd server | ||
| ``` | ||
|
|
||
| ### 2. Install Dependencies | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 3. Run the Server | ||
|
|
||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| Visit [http://localhost:5000](http://localhost:5000) in your browser to run the server of the app. | ||
|
|
||
| --- | ||
|
|
||
| ### 4. Make Changes | ||
|
|
||
| Make changes according to the tasks assigned to you. Follow the project structure and guidelines mentioned in [contributing.md](CONTRIBUTING.md) and [setup.md](Setup.md). | ||
|
|
||
| ### 5. Commit Changes | ||
|
|
||
| ```bash | ||
| git pull | ||
| git add . | ||
| git commit -s -m "fix: Updated bla bla bla" | ||
| ``` | ||
|
|
||
| ### 6. Create a Pull Request | ||
|
|
||
| Create a Pull Request on the `main` branch. Attach screenshots, a proper description, and the issue number in the Pull Request. | ||
|
|
||
|
|
||
| ## Contribution Guidelines 🔐 | ||
|
|
||
| For detailed contribution guidelines, please refer to [contributing.md](CONTRIBUTING.md). | ||
|
|
||
|
|
||
| Happy Contributing! 🎉 | ||
|
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.