mannpatel/Campus-Plug
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mann Patel
2025-03-17 18:46:30 -06:00
committed by GitHub
parent 6512d895d1
commit b8ca0fe4f2
1 changed files with 11 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,29 +1,25 @@
### Some ground rules ### Some ground rules
1. Add both node_modules from Slient and Server to your `gitignore` file 1. Add both node_modules from Slient and Server to your `gitignore` file
2. For any functionality make a brach with the prefix of your name `Name-<some branch name>` use this naming convention 2. Make a brach with the following naming conventionp, refix it with your name `name-some branch name`.
### `frontend` ### `frontend`
- Use React Js - Use React Js and vite as the node manger
- Use vite as the node manger ```Bash
```bash
npm install npm install
``` ```
3. To start the server, cd into the dir and then type command `npm run dev` 2. **Start The Server**, `cd frontend` into the dir and then type command
```Bash
npm run dev
```
### `backend` ### `backend`
1. Install the needed lib with the command bellow 1. Install the needed lib with the command bellow
``` bash ```Bash
npm install npm install
``` ```
2. make sure in the `package.json` file type is set to module, if it's not there, add it! 2. **Start The Server**, `cd backend` into the dir and then type command
```json ```Bash
{ npm run dev
...,
"type": "module"
}
``` ```
3. To start the server, cd into the dir and then type command `npm run dev`
### Database ### Database
- MySql Version 9.2.0 - MySql Version 9.2.0