Skip to content

Commit e04d3d4

Browse files
committed
add docker startup to readme
1 parent 053f2ad commit e04d3d4

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,17 @@ The API for a better world. More information under [human-connection.org](https:
1414

1515
> **Note:** This is only the API part of Human-Connection, you have to also checkout the [WebApp](https://github.com/Human-Connection/WebApp) which uses this API.
1616
17-
## Framework
17+
## Start Server
1818

19-
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
19+
Make sure you have installed [docker](https://www.docker.com/community-edition).
2020

21-
## Getting Started
21+
To start the service simply run:
22+
23+
```bash
24+
docker-compose up
25+
```
26+
27+
## Development
2228

2329
> we recommand to install the project locally for the best development ease and performance
2430

0 commit comments

Comments
 (0)