Documentation

Squashed and rebased

README.md

@@ -1,7 +1,7 @@
 # zfinger
 React app that talks to a RESTful-ish API written in Python/Flask.
 
-API endpoints:
+## API endpoints:
 
 | Path | Method | Requires Log-in | Result |
 | ----- | ----- | ----- | ----- |
@@ -17,9 +17,9 @@ API endpoints:
 
 If log-in is required, user will be redirected to `login.kth.se` if not already.
 
-Information displayed in `hodis` is `ugKthid`,`uid`,`on`,`mail`,`givenName`,`displayName`,`year` and`tag`.
+Information displayed in `hodis` is `ugKthid`,`uid`,`cn`,`mail`,`givenName`,`displayName`,`year` and`tag`.
 
-Required environment variables:
+## Required environment variables:
 ```
   AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
   AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
@@ -29,3 +29,17 @@ Required environment variables:
   HODIS_HOST=https://hodis.datasektionen.se
   LOGIN_HOST=https://login2.datasektionen.se
 ```
+
+## Dependencies
+Depends on login, hodis is refered to but not integral.
+
+## Development
+With docker installed, run `docker-compose up --build`, <localhost.datasektionen.se:5000> will be the local development version.
+Will look for ENV in a file called variables.env.
+
+## Production
+See development, on production machine.
+
+## PLs permissions
+None, merely checks if user can login in, not any permissions.
+