Skip to content

Commit

Permalink
move populated readme to highest directory level
Browse files Browse the repository at this point in the history
  • Loading branch information
rwblair committed Jun 6, 2017
1 parent 7dcbebc commit 911d14a
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# mriqcwebapi
Built on:
* [Python Eve](http://python-eve.org/)
* [Python Gunicorn](http://gunicorn.org/)
* [Nginx](https://nginx.org/)
* [Docker](https://www.docker.com/)

## Run
Example of commands to run locally to start:
```sh
$ cd dockereve-master/
$ docker-compose build
$ docker-compose up -d
$ curl -i -H "Content-Type: application/json" http://localhost/api/v1/T1w
```

Swagger API documentation available at `http://localhost/docs`.

## Environment variables in Docker
To properly run the file dockereve-master/.env needs to be populated the following are the default values:
```
MONGODB_HOST=mongodb
MONGODB_PORT=27017
API_TOKEN=<secret_token>
API_URL=http://localhost/docs/api
```

If docker is running natively these values should work, otherwise API_URL may need to be updated from localhost accordingly.
27 changes: 0 additions & 27 deletions dockereve-master/README.md

This file was deleted.

0 comments on commit 911d14a

Please sign in to comment.