add build and run instructions
parent
40377cb4f4
commit
584b851b4c
@ -1,3 +1,32 @@
|
||||
# RandomRedditMemesAPI
|
||||
|
||||
an API that returns random Reddit Submissions written in Java
|
||||
an API that returns random Reddit Submissions written in Java
|
||||
|
||||
## build and run
|
||||
|
||||
### build project
|
||||
first make sure you're using Gradle 6.8 and openjdk-jdk8
|
||||
|
||||
to build the project just run:
|
||||
```
|
||||
gradle build
|
||||
```
|
||||
|
||||
### run
|
||||
to execute the .jar archive you built before run:
|
||||
```
|
||||
java -jar ./build/libs/RandomRedditMemesAPI.jar
|
||||
```
|
||||
|
||||
### run inside docker
|
||||
to execute the .jar file inside docker use docker-compose:
|
||||
```
|
||||
docker-compose -p RandomRedditMemesAPI up -docker
|
||||
```
|
||||
|
||||
### build docker image
|
||||
if you want to build a full docker image run:
|
||||
```
|
||||
docker build .
|
||||
```
|
||||
alternatively you can use `./docker/docker-compose.yml`
|
||||
|
Loading…
Reference in New Issue