From b2fffb93c3c00a74b880d7b210aa9d6499baa2e4 Mon Sep 17 00:00:00 2001 From: Robin Chaillou <90150299+desboisGIT@users.noreply.github.com> Date: Thu, 9 Jan 2025 10:31:04 +0100 Subject: [PATCH] Update README.md for clarity --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5f3fd12..fd2dfaa 100644 --- a/README.md +++ b/README.md @@ -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: