Skip to content

Commit 21262c7

Browse files
committed
Update README
1 parent 1657e2f commit 21262c7

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Memory management app
1515

1616
## Requirement
1717

18-
Only `docker` and `docker compose plugin` are needed for development.
19-
VSCode is recommended as IDE.
18+
Only `docker` and `docker compose plugin` are needed for development. Its official guide [here](https://docs.docker.com/engine/install/).
19+
[VisualStudio Code](https://code.visualstudio.com/) is recommended as IDE.
2020

2121
## Development
2222

@@ -29,31 +29,38 @@ docker compose run --rm frontend pnpm install
2929

3030
# Run development server inside docker container
3131
docker compose up
32+
```
33+
34+
Open it in browser on [localhost:5137](http://localhost:5173/)
3235

33-
# Run test
36+
## Run test
37+
38+
```bash
3439
docker compose run --rm frontend pnpm tests
40+
```
41+
42+
## Optional
3543

36-
# Optionally, execute other commands if necessary
44+
```bash
45+
# Execute other commands if necessary
3746
docker compose run --rm frontend <command inside container>
3847
docker compose run --rm frontend pnpm --version
3948

40-
# Optionally, remove any residual data, volumes, container history etc...
49+
# Remove any residual data, volumes, container history etc...
4150
docker compose rm -fsv
4251
```
4352

4453
## Debug with test backend
4554

4655
```bash
47-
# Add .env file with test backend endpoints. then re-run docker compose
56+
# Add .env file with test backend endpoints, then re-run docker compose
4857
cat >> .env << 'END'
4958
NEURON_API=https://<api gateway id>.execute-api.<aws env>.amazonaws.com/prod/neuron
5059
NTREE_API=https://<api gateway id>.execute-api.<aws env>.amazonaws.com/prod/ntree
5160
END
5261
```
5362

54-
Open in browser on [localhost:5137](http://localhost:5173/)
55-
56-
## Develop setup
63+
## Development Setup
5764

5865
Install recommended VSCode plugins for code styles and linting
5966

0 commit comments

Comments
 (0)