@@ -15,8 +15,8 @@ Memory management app
15
15
16
16
## Requirement
17
17
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.
20
20
21
21
## Development
22
22
@@ -29,31 +29,38 @@ docker compose run --rm frontend pnpm install
29
29
30
30
# Run development server inside docker container
31
31
docker compose up
32
+ ```
33
+
34
+ Open it in browser on [ localhost:5137] ( http://localhost:5173/ )
32
35
33
- # Run test
36
+ ## Run test
37
+
38
+ ``` bash
34
39
docker compose run --rm frontend pnpm tests
40
+ ```
41
+
42
+ ## Optional
35
43
36
- # Optionally, execute other commands if necessary
44
+ ``` bash
45
+ # Execute other commands if necessary
37
46
docker compose run --rm frontend < command inside container>
38
47
docker compose run --rm frontend pnpm --version
39
48
40
- # Optionally, remove any residual data, volumes, container history etc...
49
+ # Remove any residual data, volumes, container history etc...
41
50
docker compose rm -fsv
42
51
```
43
52
44
53
## Debug with test backend
45
54
46
55
``` 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
48
57
cat >> .env << 'END '
49
58
NEURON_API=https://<api gateway id>.execute-api.<aws env>.amazonaws.com/prod/neuron
50
59
NTREE_API=https://<api gateway id>.execute-api.<aws env>.amazonaws.com/prod/ntree
51
60
END
52
61
```
53
62
54
- Open in browser on [ localhost:5137] ( http://localhost:5173/ )
55
-
56
- ## Develop setup
63
+ ## Development Setup
57
64
58
65
Install recommended VSCode plugins for code styles and linting
59
66
0 commit comments