benchmark-scoreboard/README.md

36 lines
962 B
Markdown
Raw Normal View History

2017-04-11 20:26:09 +00:00
# scoreboard-benchmark
2017-04-17 09:13:50 +00:00
![Travis CI](https://travis-ci.com/Metonimie/benchmark-scoreboard.svg?token=A1YGCrBhxwT3nHmAHZ9Q&branch=master)
2017-04-11 20:23:47 +00:00
This is a simple web app used for an university projects.
You will need **Python 2.6+ or Python 3.3+** to run this app.
Flask doesn't support Python 3.2.
2017-04-15 21:33:56 +00:00
2017-04-11 20:23:47 +00:00
It should provide a simple score board display
for some benchmarking data which is gathered from another application.
2017-04-13 14:01:38 +00:00
## Installing
2017-04-15 20:59:36 +00:00
To install and run the application, you must do the following:
Rename the config.lock.py to config.py, so you can safely modify the config.py and still have
config.lock.py as a template.
2017-04-13 14:02:26 +00:00
and update the file to match your configuration settings.
2017-04-13 14:01:38 +00:00
Then run:
2017-04-15 20:59:36 +00:00
```bash
2017-04-15 21:33:56 +00:00
pip install -r requirements.txt
python setup.py install
2017-04-20 22:35:52 +00:00
python application.py
2017-04-13 14:01:38 +00:00
```
You may set BSFLASK_ENV environment variable to production, development or testing.
2017-04-15 21:31:42 +00:00
### Running Tests
2017-04-13 05:49:05 +00:00
2017-04-15 20:59:36 +00:00
In the root directory, run the following command:
2017-04-13 05:49:05 +00:00
2017-04-15 20:59:36 +00:00
```bash
python -m unittest
```