Skip to content
This repository has been archived by the owner on May 22, 2021. It is now read-only.

Commit

Permalink
Update README.md (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-hb authored Apr 1, 2020
1 parent 1921abe commit 61bb613
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
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

0 comments on commit 61bb613

Please sign in to comment.