Commit faa086f3 authored by Marius's avatar Marius

upd readme and reqs

parent 3f68cd6e
......@@ -4,7 +4,7 @@ The eGSIM shakemap is comprised of a backend service (`api.py`) and a front end
# Installation
The backend build relies on [pipenv](https://pipenv.kennethreitz.org/en/latest/). To install the frontend a version of Node.js and npm (Node package manager) is required. I recommend serving the final build (`front-end/shakemap/dist`) through nginx webserver. For further information spawning
The backend build relies on [pipenv](https://pipenv.kennethreitz.org/en/latest/). To install the frontend a version of Node.js and npm (Node package manager) is *required*. I recommend serving the final build (`front-end/shakemap/dist`) through nginx webserver. For further information spawning
the development server as well as building the site go to the *Readme.md* inside `front-end`.
## Start services
......@@ -17,4 +17,12 @@ Starting the front end:
cd front-end/shakemap
npm install # This needs to be done just once or if new dependencies were added
npm run serve
\ No newline at end of file
npm run serve
Starting the API documentation:
cd front-end/api_documentation
git clone https://github.com/swagger-api/swagger-node
npm start
Go to open http://localhost:8081/docs
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment