Mac setup script solid now

Author: stevebrownlee

README.md

@@ -1,4 +1,4 @@
-# NSS Instructor Applications Project
+# Learning Platform Project
 
 ## Installs Needed
 
@@ -20,22 +20,14 @@ Go to [Postgresapp](https://postgresapp.com/) to download and run the Postgres a
 
 pgAdmin is not a required install, but if you ever have the desire to have a browser-based interface for working directly with the database, go to [pgAdmin](https://www.pgadmin.org/download/) to download the administration tool for Postgres.
 
-## Setup
+## Getting Started
 
-### Getting Started
+1. Fork this repo to your own Github account.
+2. Clone it.
+3. `cd` into the project directory.
+4. Run `pipenv shell` to create a virtual environment.
 
-Fork this repo to your own Github account, and then clone it. Then `cd` into the project directory.
-
-### Project Installs and Config
-
-If you are running on a Mac or Ubuntu, run the following commands.
-
-```sh
-pipenv shell
-pipenv install
-```
-
-### Github OAuth App
+## Github OAuth App
 
 1. Go to your Github account settings
 2. Open **Developer Settings**
@@ -48,53 +40,36 @@ pipenv install
 9. Leave **Enable Device Flow** unchecked
 10. Create the app and **do not close** the screen that appears
 11. Go to Github and click the **Generate a new client secret** button
-14. **DO NOT CLOSE THIS TAB OR NAVIGATE AWAY**
-
-### Environment Variables
-
-Several environment variables need to be set up by you to make the setup process faster and more secure. Set up the following environment variables anywhere in your shell initialization file _(i.e. `.bashrc` or `.zshrc`)_.
+12. **DO NOT CLOSE TAB. CLIENT AND SECRET NEEDED BELOW.**
 
-#### OAuth
+## Environment Variables
 
-Copy the client ID and secret key that was generated in the previous step as the value of the corresponding variables.
+Several environment variables need to be set up by you to make the setup process faster and more secure.
 
-```sh
-export LEARN_OPS_CLIENT_ID={Github app client ID}
-export LEARN_OPS_SECRET_KEY={Github app secret}
-```
+### Django Secret Key
 
-#### Database
-
-> **Tip:** You get to pick any Postgres password you want, but don't use spaces in it.
-
-```sh
-export LEARN_OPS_DB=learnops
-export LEARN_OPS_USER=learnops
-export LEARN_OPS_PASSWORD={Postgres user password}
-export LEARN_OPS_HOST=localhost
-export LEARN_OPS_PORT=5432
-```
-
-#### Django Secret Key
-
-To generate a Django secret key, run the following command in your terminal.
+You will need a Django secret key environment variable. Run the following command in your terminal to generate one and save it for later.
 
 ```sh
 python3 -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"
 ```
 
-Then add a new variable to your init file.
-
-```sh
-export LEARN_OPS_DJANGO_SECRET_KEY="{insert generated key}"
-```
-
-#### Django Allowed Hosts
+### All Variables Needed
 
-Add the following environment variable to your init file. If you are running the API in a container using a tool like Multipass or Docker, you must add the IP address of the container to this comma-separated list.
+Set up the following environment variables anywhere in your shell initialization file _(i.e. `.bashrc` or `.zshrc`)_.
 
 ```sh
-export LEARN_OPS_ALLOWED_HOSTS="learning.nss.team,learningapi.nss.team,127.0.0.1,localhost"
+export LEARN_OPS_DB=learnopsdev
+export LEARN_OPS_USER=learnopsdev
+export LEARN_OPS_PASSWORD=DatabasePasswordOfYourChoice
+export LEARN_OPS_HOST=127.0.0.1
+export LEARN_OPS_PORT=5432
+export LEARN_OPS_CLIENT_ID=GithubOAuthAppClientId
+export LEARN_OPS_SECRET_KEY=GithubOAuthAppSecret
+export LEARN_OPS_DJANGO_SECRET_KEY="GeneratedDjangoSecretKey"
+export LEARN_OPS_ALLOWED_HOSTS="127.0.0.1,localhost"
+export LEARN_OPS_SUPERUSER_NAME=AdminUsernameOfYourChoice
+export LEARN_OPS_SUPERUSER_PASSWORD=AdminPasswordOfYourChoice
 ```
 
 ### Activate Environment Variables
@@ -108,7 +83,7 @@ In the main directory there is a bash script that you can run to create the data
 It will prompt you for your password.
 
 ```sh
-./createdb.sh
+./setup_mac.sh
 ```
 
 > For Mac, if you get feedback that `psql command not found`, add the following to your PATH in your shell initialization file _(.bashrc or .zshrc)_. Make sure the version is correct. You may not have version 10 of Postgres. If you don't, determine your version and replace the 10.
@@ -117,20 +92,6 @@ It will prompt you for your password.
 >    /Applications/Postgres.app/Contents/Versions/10/bin
 >    ```
 
-
-### Seed the Database
-
-In the main directory there is a bash script that you can run to create the tables and seed some data. You can run it with the command below.
-
-```sh
-./seed.sh
-```
-
-
-### Create a Superuser
-
-Create a Django superuser account with `python manage.py createsuperuser`. This will give you an account with which you can get into the admin site.
-
 ## Testing the Installation
 
 1. Start the API in debug mode in Visual Studio Code.

djangopass.py

@@ -0,0 +1,5 @@
+import sys
+from django.contrib.auth.hashers import make_password
+
+print(make_password(sys.argv[1]))
+sys.exit(0)

setup_mac.sh

@@ -1,9 +1,76 @@
 #!/bin/bash
 
-psql -c "DROP DATABASE IF EXISTS $USER WITH (FORCE);"
-psql -c "CREATE DATABASE $USER;"
-psql -c "CREATE USER $USER WITH PASSWORD '$LEARN_OPS_PASSWORD';"
-psql -c "ALTER ROLE $USER SET client_encoding TO 'utf8';"
-psql -c "ALTER ROLE $USER SET default_transaction_isolation TO 'read committed';"
-psql -c "ALTER ROLE $USER SET timezone TO 'UTC';"
-psql -c "GRANT ALL PRIVILEGES ON DATABASE $USER TO $USER;"
+psql -c "DROP DATABASE IF EXISTS $LEARN_OPS_USER WITH (FORCE);"
+psql -c "CREATE DATABASE $LEARN_OPS_USER;"
+psql -c "CREATE USER $LEARN_OPS_USER WITH PASSWORD '$LEARN_OPS_PASSWORD';"
+psql -c "ALTER ROLE $LEARN_OPS_USER SET client_encoding TO 'utf8';"
+psql -c "ALTER ROLE $LEARN_OPS_USER SET default_transaction_isolation TO 'read committed';"
+psql -c "ALTER ROLE $LEARN_OPS_USER SET timezone TO 'UTC';"
+psql -c "GRANT ALL PRIVILEGES ON DATABASE $LEARN_OPS_USER TO $LEARN_OPS_USER;"
+
+echo '[
+    {
+       "model": "sites.site",
+       "pk": 1,
+       "fields": {
+          "domain": "learningplatform.com",
+          "name": "Learning Platform"
+       }
+    },
+    {
+        "model": "socialaccount.socialapp",
+        "pk": 1,
+        "fields": {
+            "provider": "github",
+            "name": "Github",
+            "client_id": "'"$LEARN_OPS_CLIENT_ID"'",
+            "secret": "'"$LEARN_OPS_SECRET_KEY"'",
+            "key": "",
+            "sites": [
+                1
+            ]
+        }
+    }
+  ]
+' > ./LearningAPI/fixtures/socialaccount.json
+
+
+export DJANGO_SETTINGS_MODULE="LearningPlatform.settings"
+PWD=$(python3 ./djangopass.py $LEARN_OPS_SUPERUSER_PASSWORD >&1)
+
+
+echo '[
+    {
+        "model": "auth.user",
+        "pk": null,
+        "fields": {
+            "password": "'$PWD'",
+            "last_login": null,
+            "is_superuser": true,
+            "username": "[email protected]",
+            "first_name": "Admina",
+            "last_name": "Straytor",
+            "email": "[email protected]",
+            "is_staff": true,
+            "is_active": true,
+            "date_joined": "2023-03-17T03:03:13.265Z",
+            "groups": [
+                2
+            ],
+            "user_permissions": []
+        }
+    }
+]' > ./LearningAPI/fixtures/superuser.json
+
+# Install project requirements
+pipenv install
+
+# Run existing migrations
+python3 manage.py migrate
+
+# Load data from backup
+python3 manage.py loaddata socialaccount
+python3 manage.py loaddata complete_backup
+python3 manage.py loaddata superuser
+
+rm ./LearningAPI/fixtures/superuser.json