rushilwiz/studyguidebank
1
0
Fork 0
mirror of https://github.com/tjsga/studyguidebank.git synced 2025-04-09 22:40:16 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Invinceaman 2020-06-09 11:12:32 -04:00
parent c6145cfcb2
commit c89f58ee3a
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -0,0 +1,10 @@
# Study Bank
## Development
- clone the git repo
- create `settings/secret.py` based on `settings/secret.sample`
- register an OAuth app with Ion for authentication (client-type = confidential, auth-grant-type = authorization-code)
- copy the client_id for SOCIAL_AUTH_ION_KEY and client_secret for SOCIAL_AUTH_ION_SECRET from Ion to `settings/secret.py`
- edit `settings/__init__.py` so that `MEDIA_ROOT` and `STATIC_ROOT` point to your desired directories (you also need to create these directories)
- uploaded documents will be stored in the media directory, and static files will be collected to the static directory
- django will not serve any files in either of these directories, so you need to make sure your web server will