|
1 |
| -# Frontend Setup |
2 |
| - |
3 |
| -Follow the below steps to setup the Frontend locally. We are using `npm` as the package manager. So make sure you have `node` and `npm` installed in your system. |
4 |
| - |
5 |
| -**If not installed, please read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).** |
6 |
| -## Installing dependencies ⏳ |
7 |
| - |
8 |
| -- Open your terminal and navigate to the `Milan` directory. |
9 |
| -- Type `npm install` to install all the dependencies. |
10 |
| -- Once the installation is done, you can start the frontend server by typing `npm run dev`. |
11 |
| -- This should start the frontend server on `localhost:3000`. |
12 |
| - |
13 |
| -## Techstack overview 🌀 |
14 |
| - |
15 |
| -- We are currently using `ReactJS v18` along with `vite v3` as the frontend framework. |
16 |
| -- We using `Twitter Bootstrap v5` for the styling. |
17 |
| -- List of all the dependencies can be found in the `package.json` file. |
18 |
| - |
19 |
| - |
20 |
| -## Coding standards 🔐 |
21 |
| - |
22 |
| -- We are using `ESLint` and `Prettier` for linting and formatting. |
23 |
| -- Maintain the same coding standards as the rest of the codebase. |
24 |
| -- Follow good naming conventions for the files, variables and functions along with proper documentation (if needed). |
25 |
| -- We also use `husky` and `lint-staged` to run the linter and formatter before every commit. Read about this in our [Contributing Guidelines](/CONTRIBUTING.md). |
26 |
| -- Maintain a good folder structure, incase you use anu new components or pages make sure you put them in the right folder. |
27 |
| -- If you are using any new dependencies, make sure you mention them in the PR. |
28 |
| -- If you are using any new Image , compress it using [online tools]("https://www.iloveimg.com/compress-image") and then use it in the project. |
29 |
| -- **Remember**, writing readable and clean code while following the coding standards is the best thing for any developer. |
30 |
| -## Next steps 🚀 |
31 |
| - |
32 |
| -So now you have the the frontend up and running locally. Now you can start working on the issues. |
33 |
| - |
34 |
| -- If you don't need to modify/work on anything related to the backend, you can skip the backend setup and simply setup a `.env` file in the root. |
35 |
| -- Inside that `.env` file you can put `VITE_MILANAPI="https://milan-server.vercel.app"` |
36 |
| -- If you need your own backend and want to make changes there as well, you can follow [Setting up the backend locally](/rules/BackendSetup.md) |
| 1 | +# Frontend Setup |
| 2 | + |
| 3 | +Follow the below steps to setup the Frontend locally. We are using `npm` as the package manager. So make sure you have `node` and `npm` installed in your system. |
| 4 | + |
| 5 | +**If not installed, please read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).** |
| 6 | +## Installing dependencies ⏳ |
| 7 | + |
| 8 | +- Open your terminal and navigate to the `Milan` directory. |
| 9 | +- Type `npm install` to install all the dependencies. |
| 10 | +- Once the installation is done, you can start the frontend server by typing `npm run dev`. |
| 11 | +- This should start the frontend server on `localhost:3000`. |
| 12 | + |
| 13 | +## Techstack overview 🌀 |
| 14 | + |
| 15 | +- We are currently using `ReactJS v18` along with `vite v3` as the frontend framework. |
| 16 | +- We using `Twitter Bootstrap v5` for the styling. |
| 17 | +- List of all the dependencies can be found in the `package.json` file. |
| 18 | + |
| 19 | + |
| 20 | +## Coding standards 🔐 |
| 21 | + |
| 22 | +- We are using `ESLint` and `Prettier` for linting and formatting. |
| 23 | +- Maintain the same coding standards as the rest of the codebase. |
| 24 | +- Follow good naming conventions for the files, variables and functions along with proper documentation (if needed). |
| 25 | +- We also use `husky` and `lint-staged` to run the linter and formatter before every commit. Read about this in our [Contributing Guidelines](/CONTRIBUTING.md). |
| 26 | +- Maintain a good folder structure, incase you use anu new components or pages make sure you put them in the right folder. |
| 27 | +- If you are using any new dependencies, make sure you mention them in the PR. |
| 28 | +- If you are using any new Image , compress it using [online tools]("https://www.iloveimg.com/compress-image") and then use it in the project. |
| 29 | +- **Remember**, writing readable and clean code while following the coding standards is the best thing for any developer. |
| 30 | +## Next steps 🚀 |
| 31 | + |
| 32 | +So now you have the the frontend up and running locally. Now you can start working on the issues. |
| 33 | + |
| 34 | +- If you don't need to modify/work on anything related to the backend, you can skip the backend setup and simply setup a `.env` file in the root. |
| 35 | +- Inside that `.env` file you can put `VITE_MILANAPI="https://milan-server.vercel.app"` |
| 36 | +- If you need your own backend and want to make changes there as well, you can follow [Setting up the backend locally](/rules/BackendSetup.md) |
| 37 | + |
0 commit comments