Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Documentation #17

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a44341d
Documentation
brynolv Jan 15, 2021
0427d2b
Reviews round 1
brynolv Mar 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
| ----- | ----- | ----- | ----- |
Expand All @@ -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>
Expand All @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Depends on login, hodis is refered to but not integral.
Depends on login, hodis is referred to but not integral.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hodis is very integral. That is where zfinger fetches all information about users. Without hodis, zfinger would be pointless.

EDIT: @DokID I will forever write referer, this is HTTP's fault.

Copy link
Contributor Author

@brynolv brynolv Mar 25, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattiasgrenfeldt Well... technically, zfinger works fine. Doesn't display anything, but it doesn't crash, the app itself works fine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. The point of zfinger is to look up people, that's the core functionality. Without hodis that functionality is impossible. So hodis is very much integral to zfinger.


## 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.
brynolv marked this conversation as resolved.
Show resolved Hide resolved

## Production
See development, on production machine.
brynolv marked this conversation as resolved.
Show resolved Hide resolved

## PLs permissions
None, merely checks if user can login in, not any permissions.
brynolv marked this conversation as resolved.
Show resolved Hide resolved