Update readme, gitignore

This commit is contained in:
radex 2024-07-05 16:01:00 +02:00
parent 60021fb738
commit 096455eeaf
Signed by: radex
SSH key fingerprint: SHA256:hvqRXAGG1h89yqnS+cyFTLKQbzjWD4uXIqw7Y+0ws30
2 changed files with 10 additions and 0 deletions

1
.gitignore vendored
View file

@ -1,5 +1,6 @@
olddata
webapp/data.db
web/webapp/data.db
*pyc
*sublime*
kasownik.ini

View file

@ -14,3 +14,12 @@ This project is divided into two separate modules:
(at least separate UID) - supports "old" IdeaBank web interface
More info about these can be found in their respective `README.md` files.
Quick Start
-----------
1. [Register new SSO application](https://sso.hackerspace.pl/client/create) - client name and URI don't matter, redirect URI should be `http://localhost:5000/oauth/callback` (by default), other settings can stay default
2. Set `SPACEAUTH_CONSUMER_KEY` and `SPACEAUTH_CONSUMER_SECRET` envs to the client generated above
3. `docker-compose run --rm kasownik-web ./manage.py syncdb` (one time)
4. Run the app: `docker-compose up --build`
5. (TODO: Add missing table for fetcher, add example data)