Update ReadMe (#168)

Co-authored-by: MiniDigger <admin@minidigger.me>
This commit is contained in:
Aurora 2020-10-05 13:09:24 +02:00 committed by GitHub
parent 051ff83d8b
commit ab856370d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -22,8 +22,7 @@ This project currently uses java 11.
### Building with Docker
If you want to build both Hangar and [HangarAuth](https://github.com/MiniDigger/HangarAuth)
to run together (without a fakeuser), clone both this repo, and [this](https://github.com/MiniDigger/HangarAuth)
(or if [this pr](https://github.com/MiniDigger/HangarAuth/pull/1) hasn't been merged, clone [this](https://github.com/Machine-Maker/HangarAuth/tree/machines-hangarauth)).
to run together (without a fakeuser), clone both this repo, and [this](https://github.com/PaperMC/HangarAuth).
Make sure both Hangar and HangarAuth directories are siblings in your file system. cd into Hangar/docker and run `docker-compose up -d`. That should set everything up for you. You can view the logs via Intellij's docker integration.
I find its better to view the logs there, so that the Hangar logs and HangarAuth logs are separated.
Note that when using docker, a different spring configuration file is used, `Hangar/docker/hangar/application.yml`. To reload changes to Hangar, just CTRL+F9 (rebuild) in Intellij. To rebuild changes to HangarAuth, just run `docker-compose up -d --build`
@ -36,7 +35,7 @@ Deployment happens via Docker, checkout the stack in the docker folder. You will
## Contributing
There is a bunch of stuff to do, some of that is noted in the [**Roadmap Project**](https://github.com/PaperMC/Hangar/projects/1).
Your best bet is joining #hangar-dev on the paper discord and just discussing with us.
Your best bet is joining #hangar-dev on the [paper discord](https://discord.gg/papermc) and just discussing with us.
All contributions are very welcome, we will not be able to finish this alone!
## Licence