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-05 22:34:29 -07:00
committed by GitHub
parent 49929a85da
commit a15a3fcf4c
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,28 +1,28 @@
# Campus-Plug # Some ground rules
The ultimate plug for student deals
## 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. Do not use `.ENV` variables 2. For any functionality make a brach with the prefix of your name `Name-<some branch name>` use this namign convention
3. For any functionality make a brach with the prefix of your name `Name-<some branch name>` use this namign convention
4. For all method added a comment as to what it does
## Client ## `frontend`
- Use React Js - Use React Js
- Use vite as the node manger - Use vite as the node manger
## Server ```
npm install express cors react-router-dom lucid-react
```
3. To start the server, cd into the dir and then type command `npm run dev`
## `backend`
1. Install the needed lib with the command bellow 1. Install the needed lib with the command bellow
``` bash ``` bash
npm install express mysql2 dotenv cors npm install express mysql2 dotenv cors
``` ```
2. make sure in the `package.json` file type is set to module, if it not there add it. 2. make sure in the `package.json` file type is set to module, if it's not there, add it!
```json ```json
{ {
..., ...,
"type": "module" "type": "module"
} }
``` ```
3. To start the server, cd into server dir and then type command `npm run start` 3. To start the server, cd into the dir and then type command `npm run start`
### Database ### Database
- Use only mySQL database - Use only mySQL database