simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve readme 📝

Browse source 
[ci skip]
This commit is contained in:
Jannis R 2019-06-11 13:56:21 +02:00
parent bb4cf73c56
commit 26994889f4
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
readme.md
View file

@ -13,16 +13,27 @@
[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)
## Installing
## installing & running
### via Docker
A Docker image [is available as `derhuerst/db-rest`](https://hub.docker.com/r/derhuerst/db-rest).
```shell
docker run -d -p 3000:3000 derhuerst/db-rest
```
### manually
```shell
git clone https://github.com/derhuerst/db-rest.git
cd db-rest
git checkout 2
npm install --production
npm start
```
[A Docker image is available as `derhuerst/db-rest`.](https://hub.docker.com/r/derhuerst/db-rest)
To keep the API running permanently, use tools like [`forever`](https://github.com/foreverjs/forever#forever), [`pm2`](http://pm2.keymetrics.io) or [`systemd`](https://wiki.debian.org/systemd).
## Contributing