Projects/grzegorz-clients
Projects
/
grzegorz-clients
7
1
Fork 0
Code Issues 1 Pull Requests 1 Wiki Activity
A set of simple API endpoints and ready-to-go clients to interface with the Grzegorz API
56 Commits 4 Branches 0 Tags 1.8 MiB
Python 57%
CSS 32.3%
Nix 10.4%
Shell 0.3%
Go to file
Peder Bergebakken Sundt 63de4be667
Merge pull request #2 from Programvareverkstedet/dependabot/pip/ujson-5.4.0 
Bump ujson from 5.2.0 to 5.4.0
 		2022-07-06 13:31:02 +02:00
dist Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00
grzegorz_clients Type annotation, linter fixes and cleanup 2022-02-20 00:22:57 +01:00
.envrc Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00
.gitignore Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00
LICENSE Add readme and license 2018-02-26 23:06:09 +01:00
README.md Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00
dev.sh Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00
poetry.lock Bump ujson from 5.2.0 to 5.4.0 2022-07-05 22:35:32 +00:00
pyproject.toml Switch to use poetry, use a cli interface instead of a config file. 2022-02-20 00:09:25 +01:00

README.md

Gregorz Clients

A set of simple API endpoints and ready-to-go clients to interface with the Grzegorz API

Working clients:

  • A webUI client made with REMI

Planned future clients:

  • CLI client
  • WebExtensions browser extension

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. ;)

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:

$ systemctl --user enable grzegorz_webui.service
$ systemctl --user start grzegorz_webui.service

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 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

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