From 911d14ad710458c60ea6e4ae2343b0f5db0d43ba Mon Sep 17 00:00:00 2001 From: Ross Blair Date: Tue, 6 Jun 2017 13:52:54 -0700 Subject: [PATCH] move populated readme to highest directory level --- README.md | 29 ++++++++++++++++++++++++++++- dockereve-master/README.md | 27 --------------------------- 2 files changed, 28 insertions(+), 28 deletions(-) delete mode 100644 dockereve-master/README.md diff --git a/README.md b/README.md index 2caf1e2..372ff69 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -# mriqcwebapi \ No newline at end of file +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= +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. diff --git a/dockereve-master/README.md b/dockereve-master/README.md deleted file mode 100644 index 197223c..0000000 --- a/dockereve-master/README.md +++ /dev/null @@ -1,27 +0,0 @@ -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 -$ 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= -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.