|
1 | | -# submit the force |
| 1 | +# Submit the Force |
2 | 2 |
|
3 | | -This project uses Quarkus, the Supersonic Subatomic Java Framework. |
| 3 | +The latest incarnation of the Submit, the interface provided to potential speakers to submit their talks to the JavaZone conference. |
4 | 4 |
|
5 | | -If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>. |
6 | 5 |
|
7 | | -## Running the application in dev mode |
| 6 | +## Starting development environment |
8 | 7 |
|
9 | | -You can run your application in dev mode that enables live coding using: |
| 8 | +### Configuration of Moresleep |
10 | 9 |
|
11 | | -```shell script |
12 | | -./mvnw quarkus:dev |
| 10 | +To run Moresleep locally, it may be configured using a `.env.moresleep` file. The following is an example of file to make it load talks from the official database: |
| 11 | + |
| 12 | +```dotenv |
| 13 | +SLEEPINGPILL_AUTH=username:password |
| 14 | +LOAD_FROM_SLEEPINGPILL=true |
13 | 15 | ``` |
14 | 16 |
|
15 | | -> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>. |
| 17 | +To get it up and running: |
16 | 18 |
|
17 | | -## Packaging and running the application |
| 19 | +```shell |
| 20 | +docker compose up -d moresleep |
| 21 | +``` |
18 | 22 |
|
19 | | -The application can be packaged using: |
20 | 23 |
|
21 | | -```shell script |
22 | | -./mvnw package |
23 | | -``` |
| 24 | +### Configuration of Submit |
24 | 25 |
|
25 | | -It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. |
26 | | -Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. |
| 26 | +To configure Submit, use a `.env` file. Content may be similar to the following: |
27 | 27 |
|
28 | | -The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. |
| 28 | +```dotenv |
| 29 | +# Configuration of the application itself (default values) |
| 30 | +APP_URL=http://localhost:8080 |
| 31 | +APP_SECRET=JavaZoneForever |
29 | 32 |
|
30 | | -If you want to build an _über-jar_, execute the following command: |
| 33 | +# Configuration of the moresleep service (default values) |
| 34 | +TALKS_LOCATION=http://localhost:8082 |
| 35 | +TALKS_USERNAME=anon |
| 36 | +TALKS_PASSWORD=anon |
31 | 37 |
|
32 | | -```shell script |
33 | | -./mvnw package -Dquarkus.package.jar.type=uber-jar |
| 38 | +# Configuration of OIDC (default values) |
| 39 | +QUARKUS_OIDC_AUTH_SERVER_URL=[configure me] |
| 40 | +QUARKUS_OIDC_CLIENT_ID=[configure me] |
| 41 | +QUARKUS_OIDC_CREDENTIALS_SECRET=[configure me] |
34 | 42 | ``` |
35 | 43 |
|
36 | | -The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. |
| 44 | +For active development, run the following command to start the application: |
| 45 | + |
| 46 | +```shell |
| 47 | +make dev |
| 48 | +``` |
| 49 | + |
| 50 | +To just get it up and running, run the following command: |
| 51 | + |
| 52 | +```shell |
| 53 | +make build |
| 54 | +docker compose up -d submit |
| 55 | +``` |
0 commit comments