Skip to content

Commit

Permalink
Merge pull request #2 from ls1intum/chore/add-development-setup-expla…
Browse files Browse the repository at this point in the history
…nation

`Chore`: Add development setup explanation to ReadMe
  • Loading branch information
SimonEntholzer authored Aug 22, 2024
2 parents af9716f + e6b0d2a commit f70c95f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
Use `docker compose up` for quick start.

## Development

### Running [Artemis](https://github.com/ls1intum/Artemis) in parallel (locally)
Adjust the port on which the telemetry service and its database are running (with the default configuration Artemis will be running on port `8080` and a mysql database on port `3306`).

Adjust the `docker-compose.yml` accordingly, e.g. the following adjustments will be needed to run the telemetry service on port `8081` and its database on port `3307`:
```
services:
telemetry:
ports:
- '127.0.0.1:8081:8080'
mysql:
ports:
- "3307:3306"
```

For using the local telemetry service in a development setup you will need to adjust the `application-dev.yml` (within Artemis, not within the telemetry service) accordingly:
```
artemis:
telemetry:
enabled: true
sendAdminDetails: true
destination: http://localhost:8081
```

0 comments on commit f70c95f

Please sign in to comment.