Skip to content
Snippets Groups Projects
Commit 08446250 authored by Hervé  MENAGER's avatar Hervé MENAGER
Browse files

update instructions in README

parent 2a589497
No related branches found
No related tags found
No related merge requests found
# JASS
## HOWTO
## setup
To run the server, please execute the following from the root directory:
The main requirement is **python 3**. To setup the server in a dedicated virtualenv (you need **virtualenv**), please execute the following from the root directory, once you have cloned the repository:
```
virtualenv venv
. venv/bin/activate
pip3 install -r requirements.txt
python3 -m swagger_server
# you can quit the virtualenv with
deactivate
```
and open your browser to here:
## run
```
# activate the virtualenv
. venv/bin/activate
# run the server, [CTRL+C] to quit
python -m swagger-server
# you can quit the virtualenv with
deactivate
```
## browse
### for end users
TODO
### for developers
The Swagger UI is there:
```
http://localhost:8080/ui/
......@@ -21,6 +43,8 @@ The Swagger definition for this server's API lives here:
http://localhost:8080/swagger.json
```
# tests
To launch the integration tests, use tox:
```
sudo pip install tox
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment