Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The readme about installing the API in docker wasn't good enough #39

Merged
merged 1 commit into from
Jul 27, 2024
Merged

The readme about installing the API in docker wasn't good enough #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
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)
Loading