docs: update README.md to format code blocks and improve clarity
This commit is contained in:
23
README.md
23
README.md
@@ -6,7 +6,7 @@ Fastify Server
|
|||||||
|
|
||||||
### Set your environment variable
|
### Set your environment variable
|
||||||
|
|
||||||
```
|
```bash
|
||||||
cd backend
|
cd backend
|
||||||
cp .env.sample .env
|
cp .env.sample .env
|
||||||
```
|
```
|
||||||
@@ -14,23 +14,26 @@ cp .env.sample .env
|
|||||||
### Development
|
### Development
|
||||||
|
|
||||||
Run a mongo container
|
Run a mongo container
|
||||||
```
|
|
||||||
|
```bash
|
||||||
docker run -d -p 27017:27017 mongo
|
docker run -d -p 27017:27017 mongo
|
||||||
```
|
```
|
||||||
|
|
||||||
Install dependencies
|
Install dependencies
|
||||||
```
|
|
||||||
|
```bash
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
Start development mode
|
Start development mode
|
||||||
```
|
|
||||||
|
```bash
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run the test
|
### Run the test
|
||||||
|
|
||||||
```
|
```bash
|
||||||
npm run test
|
npm run test
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -41,21 +44,23 @@ React (by vite)
|
|||||||
### Development
|
### Development
|
||||||
|
|
||||||
Install dependencies
|
Install dependencies
|
||||||
```
|
|
||||||
|
```bash
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
Start development mode
|
Start development mode
|
||||||
```
|
|
||||||
|
```bash
|
||||||
cd frontend
|
cd frontend
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Visit
|
Visit
|
||||||
http://localhost:5173
|
<http://localhost:5173>
|
||||||
|
|
||||||
### Run cypress test
|
### Run cypress test
|
||||||
|
|
||||||
```
|
```bash
|
||||||
npm run cy:test
|
npm run cy:test
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user