grzegorz-clients/README.md

55 lines
1.6 KiB
Markdown
Raw Normal View History

# Gregorz Clients
2018-03-02 18:09:04 +01:00
<img align="right" width="250" src="grzegorz_clients/res/logo.png">
2018-02-26 23:06:09 +01:00
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
2018-02-26 23:06:09 +01:00
## How to run this
As the user intended to run the server:
pip install --user git+https://github.com/Programvareverkstedet/grzegorz_clients.git#master
grzegorz-webui --host 0.0.0.0 --port 80
It's rather insecure and could use a reverse proxy and some whitelisting. ;)
2019-03-09 20:53:57 +01:00
## Making the webui run on boot
Modify and copy the files in `dist` to `$HOME/.config/systemd/user`, then run the following commands as the user intended to run the server:
2019-03-09 20:53:57 +01:00
2019-03-13 12:21:22 +01:00
$ systemctl --user enable grzegorz_webui.service
$ systemctl --user start grzegorz_webui.service
2019-03-09 20:53:57 +01:00
## Development
Setup virtual environment and running the server:
poetry install
grzegorz-webui --no-volume
If you also run a local instance of the Grzegorz API:
grzegorz-webui --api-base http://localhost:8000/api
If you plan on making changes to the code, preferably install [`entr`](http://entrproject.org/) and use the supplied script `dev.sh`.
It will restart the server every time you change any of the files tracked by git.
./dev.sh --api-base http://localhost:8000/api
2018-02-26 23:06:09 +01:00
## License
Licensed under BSD 3 clause, see the file LICENSE for more details
This uses the library REMI by dddomodossola, which is licensed under apache2.
This license may be read [over here](https://choosealicense.com/licenses/apache-2.0/)