Update README.md
This commit is contained in:
22
README.md
22
README.md
@@ -1,28 +1,28 @@
|
||||
# Campus-Plug
|
||||
The ultimate plug for student deals
|
||||
|
||||
## some ground rules
|
||||
# Some ground rules
|
||||
1. Add both node_modules from Slient and Server to your `gitignore` file
|
||||
2. Do not use `.ENV` variables
|
||||
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
|
||||
2. For any functionality make a brach with the prefix of your name `Name-<some branch name>` use this namign convention
|
||||
|
||||
## Client
|
||||
## `frontend`
|
||||
- Use React Js
|
||||
- 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
|
||||
``` bash
|
||||
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
|
||||
{
|
||||
...,
|
||||
"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
|
||||
- Use only mySQL database
|
||||
|
||||
Reference in New Issue
Block a user