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

Updating documentation for getting started #419

Draft
wants to merge 4 commits into
base: development
Choose a base branch
from
Draft

Updating documentation for getting started #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
31a6c90
Update instructions on creating a Client ID and initializing a .priva…
AndrewNatoli Feb 7, 2023
04679bd
Additional details for Google Cloud keys
AndrewNatoli Feb 7, 2023
025917a
Add info about Docker volumes
AndrewNatoli Feb 7, 2023
5b38bbe
Update google oauth keys page to mention .private.env
AndrewNatoli Feb 7, 2023
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
18 changes: 18 additions & 0 deletions docs/development/development_environment_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,22 @@ run the following commands::
cd docker/nginx/secrets
openssl req -x509 -newkey rsa:4096 -keyout server.key -out server.crt -days 365 -nodes

Next you will need to create volumes for the development environment::

docker volume create db-data
docker volume create task-data
docker volume create taskd-data

After that, you can bring up your development environment::

docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

You may need to create a `.private.env` file in the root project directory first::

touch .private.env

Review the troubleshooting section below to review how to start this file.

.. note::

Specifying the dockerfiles as shown above
Expand Down Expand Up @@ -57,3 +69,9 @@ Troubleshooting your Development Environment

* ``SOCIAL_AUTH_GOOGLE_OAUTH2_KEY``
* ``SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET``

* You may also need to set up the following directories in the root project directory

* /db-data
* /task-data
* /
12 changes: 9 additions & 3 deletions docs/development/google_oauth_keys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ functionally essential for doing much of anything with Inthe.AM.
1. Go to `Google's developer console <https://console.developers.google.com/project>`_.
2. Create a new project.
3. From within your project, create a new "Client ID" by going to
"APIs & Auth" > "Credentials" and clicking on the "Create New Client ID"
button.
4. Select "Web Application"
"APIs & Services" > "Credentials."
4. Click "Create Credentials" at the top of the screen and select "Create oAuth Client ID." For the "Application Type" on the next screen select "Web Application."
5. Enter the following for 'Authorized Javascript Origins'::

http://127.0.0.1
Expand All @@ -33,3 +32,10 @@ functionally essential for doing much of anything with Inthe.AM.
environment with the environment variables you've set, and start the
``runserver`` once again.

Docker Development Environment Usage
-------------------------------------

If using a Docker environment for development (see :ref:`development_environment_setup`), the key and secret should be provided in a `.private.env` file in the root project directory as::

SOCIAL_AUTH_GOOGLE_OAUTH2_KEY="key"
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET="key"