Skip to content

Commit

Permalink
[Readme improvement] The readme about installing the API in docker wa…
Browse files Browse the repository at this point in the history
…s improved (#39)
  • Loading branch information
Alathreon authored Jul 27, 2024
1 parent 6f45dc7 commit 8a7e373
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,21 @@ JShellAPI is a REST API, and whenever some code is received, it will create a se
# How to build JShellAPI in and run it in Docker
- Launch Docker
- Run `jibDockerBuild` to create the image
- Create a folder outside the project
- `cd` to this folder
- Copy `docker-compose.yaml` inside it
- Optionally, create `config/application.yaml` where you can put custom config (see the actual [application.yaml](JShellAPI/src/main/resources/application.yaml))
- If you don't create it, delete the `command: ["--spring.config.location=file:///home/backend/config/application.yaml"]` line in the `docker-compose.yaml`
* * If you don't create it, delete the `command: ["--spring.config.location=file:///home/backend/config/application.yaml"]` line in the `docker-compose.yaml`
- Run `docker compose build` or `docker-compose build` in the folder, depending on your version of Docker.
- Run `docker compose start` or `docker-compose start` in the folder, depending on your version of Docker.
- Note that some folders or files may be created automatically inside this folder
- File tree representation:
```
-folder outside the project
-docker-compose.yaml
-config (optionnal)
-application.yaml
```

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

0 comments on commit 8a7e373

Please sign in to comment.