Files
Campus-Plug/README.md

30 lines
793 B
Markdown
Raw Normal View History

2025-01-30 13:04:01 -07:00
# Campus-Plug
2025-01-30 13:37:10 -07:00
The ultimate plug for student deals
## some ground rules
2025-03-05 22:30:52 -07:00
1. Add both node_modules from Slient and Server to your `gitignore` file
2025-01-30 13:37:10 -07:00
2. Do not use `.ENV` variables
2025-02-02 22:08:21 -07:00
3. For any functionality make a brach with the prefix of your name `Name-<some branch name>` use this namign convention
2025-01-30 13:46:49 -07:00
4. For all method added a comment as to what it does
2025-01-30 13:29:13 -07:00
## Client
2025-01-30 13:43:02 -07:00
- Use React Js
- Use vite as the node manger
2025-01-30 13:29:13 -07:00
## Server
2025-01-30 13:37:10 -07:00
1. Install the needed lib with the command bellow
``` bash
npm install express mysql2 dotenv cors
```
2025-02-02 22:08:21 -07:00
2. make sure in the `package.json` file type is set to module, if it not there add it.
2025-01-30 13:37:10 -07:00
```json
{
...,
2025-02-02 22:08:21 -07:00
"type": "module"
2025-01-30 13:37:10 -07:00
}
```
2025-01-30 13:48:49 -07:00
3. To start the server, cd into server dir and then type command `npm run start`
2025-01-30 13:29:13 -07:00
2025-03-05 22:30:52 -07:00
### Database
- Use only mySQL database