Skip to content

Update README.md for clarity #19

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

Open
desboisGIT wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md for clarity #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ This is a project that demonstrates how you could implement a fully featured JSO
In order to test out this project, follow these steps:

- clone the repository
- in the frontend folder, run: npm install, this will install the required frontend packages
- in the frontend folder, run: npm run build, this will make a build folder and copy it into the backend folder
- in the backend folder, run: python3 -m venv venv
- then activate the virtual environment
- in the backend folder, run: pip install -r requirements.txt
- in the frontend folder, run: `npm install`, this will install the required frontend packages
- in the frontend folder, run: `npm run build`, this will make a build folder and copy it into the backend folder
- in the backend folder, run: `python3 -m venv venv`
- then activate the virtual environment, run: `source venv/bin/activate` (Linux) or: `.\venv\Script\activate` (Windows)
- in the backend folder, run: `pip install -r requirements.txt`

Then under backend/auth_system/settings.py:

- under DATABASES, set the PASSWORD field to your database password
- under EMAIL_HOST_USER, set the email that you want to use
- under EMAIL_HOST_PASSWORD, set the app password that you setup for your email
- under SOCIAL_AUTH_GOOGLE_OAUTH2_KEY, paste in your google oauth2 key
- under SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET, paste in your google oauth2 secret
- under SOCIAL_AUTH_FACEBOOK_KEY, paste in your facebook oauth2 key
- under SOCIAL_AUTH_FACEBOOK_SECRET, paste in your facebook oauth2 secret
- under `DATABASES, set the PASSWORD` field to your database password
- under `EMAIL_HOST_USER`, set the email that you want to use
- under `EMAIL_HOST_PASSWORD`, set the app password that you setup for your email
- under `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`, paste in your google oauth2 key
- under `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`, paste in your google oauth2 secret
- under `SOCIAL_AUTH_FACEBOOK_KEY`, paste in your facebook oauth2 key
- under `SOCIAL_AUTH_FACEBOOK_SECRET`, paste in your facebook oauth2 secret

If you get an error when using social authentication that says "ModuleNotFoundError: No module named 'django.utils.six", then do the following:

Expand Down