Projects/grzegorz-clients
Projects
/
grzegorz-clients
7
1
Fork 0
Code Issues 1 Pull Requests 1 Wiki Activity

Prettify and add info on dev.sh to README

This commit is contained in:
Peder Bergebakken Sundt 2018-03-06 17:17:43 +01:00
parent 90fd2c93b2
commit b62bd14076
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,7 +1,14 @@
# Gregorz webUI # Gregorz Clients
<img align="right" width="250" src="grzegorz_clients/res/logo.png"> <img align="right" width="250" src="grzegorz_clients/res/logo.png">
A simple webui to interface with the [Grzegorz API](https://github.com/Programvareverkstedet/grzegorz) A set of simple API endpoints and ready-to-go clients to interface with the [Grzegorz API](https://github.com/Programvareverkstedet/grzegorz)
#### Working clients:
* A webUI client made with REMI
#### Planned future clients:
* CLI client
* WebExtensions browser extension
## How to run this ## How to run this
@ -10,17 +17,20 @@ First of we need to install any needed dependencies. If you want to, you may do
To install the needed dependencies, run this with sufficient rights (as root?): To install the needed dependencies, run this with sufficient rights (as root?):
``` pip install -r requirements.txt
pip install -r requirements.txt
```
Now, make a copy of `default_config.py` named `config.py`, and make any changes you see fit. Each field should be described there Now, make a copy of `default_config.py` named `config.py`, and make any changes you see fit. Each field should be described in the file.
When finished, run the server with: When finished, run the server with:
``` python3 main.py
python3 main.py
```
## Developing on this
If you plan on making changes to the code, i advice you to install [`entr`](http://entrproject.org/) and use the supplied script `dev.sh`.
It will restart the server everytime you write a change to any of the .py files in the project.
## License ## License