This repository has been archived by the owner on May 22, 2021. It is now read-only.
generated from E-Edu/microservice-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,29 @@ | ||
# TODO | ||
Fill out Dockerfile | ||
# E-Edu Gateway Microservice | ||
|
||
Fill out docker-compose.yml | ||
This projects contains the source code for the gateway microservice which | ||
is responsible for collecting and filtering information requested by the frontend using GraphQL. | ||
|
||
Fill out GitHub Action workflow | ||
## How to build | ||
Run: | ||
```sudo docker build --tag eedu/gateway:latest .``` | ||
|
||
Fill out README | ||
## How to start the docker stack | ||
Run: | ||
```sudo docker-compose up``` | ||
|
||
or in detached mode: | ||
```sudo docker-compose up -d``` | ||
|
||
## Contribute | ||
|
||
You want to contribute to this project? Great! | ||
|
||
[Drafts & Documentation](https://github.com/E-Edu/draft-documents)<br> | ||
[Git Workflow (German)](https://github.com/E-Edu/general/blob/master/guides/conventions.md)<br> | ||
[Code Style (German)](https://github.com/E-Edu/general/blob/master/guides/conventions.md#code-style) | ||
|
||
|
||
## License | ||
|
||
This project is licensed under the `GNU General Public License v3.0`<br> | ||
See `LICENSE` for more information |