Skip to content

Commit 8a7e373

Browse files
authored
[Readme improvement] The readme about installing the API in docker was improved (#39)
1 parent 6f45dc7 commit 8a7e373

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

Diff for: README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,21 @@ JShellAPI is a REST API, and whenever some code is received, it will create a se
2929
# How to build JShellAPI in and run it in Docker
3030
- Launch Docker
3131
- Run `jibDockerBuild` to create the image
32+
- Create a folder outside the project
33+
- `cd` to this folder
34+
- Copy `docker-compose.yaml` inside it
3235
- Optionally, create `config/application.yaml` where you can put custom config (see the actual [application.yaml](JShellAPI/src/main/resources/application.yaml))
33-
- If you don't create it, delete the `command: ["--spring.config.location=file:///home/backend/config/application.yaml"]` line in the `docker-compose.yaml`
36+
* * If you don't create it, delete the `command: ["--spring.config.location=file:///home/backend/config/application.yaml"]` line in the `docker-compose.yaml`
3437
- Run `docker compose build` or `docker-compose build` in the folder, depending on your version of Docker.
3538
- Run `docker compose start` or `docker-compose start` in the folder, depending on your version of Docker.
39+
- Note that some folders or files may be created automatically inside this folder
40+
- File tree representation:
41+
```
42+
-folder outside the project
43+
-docker-compose.yaml
44+
-config (optionnal)
45+
-application.yaml
46+
```
3647

3748
## How to use JShellApi ?
3849
See [JShellAPI README](JShellAPI/README.MD)

0 commit comments

Comments
 (0)