Run command:

ssh-keygen -t rsa -b 4096 -C "your_email@domain.com"

Hit enter to accept default file location, and again to accept empty passphrase

Install xclip

sudo apt-get install xclip

To copy to clipboard, run:

xclip -sel clip < ~/.ssh/id_rsa.pub

Download tarball from HERE

Extract tarball and replace <VERSION> with the actual package name:

sudo tar -xzf jetbrains-toolbox-<VERSION>.tar.gz -C /opt

Run the install script. Replace <VERSION> with the actual package name:

cd /opt/jetbrains-toolbox-<VERSION>
./jetbrains-toolbox

Follow prompts and install Pycharm Community IDE

sudo snap install curl

sudo apt install python3.9-venv

sudo apt install python3-distutils

sudo curl -sSL https://install.python-poetry.org | python3 -

Append the following to ~/.profile

export PATH="/home/adrian/.local/bin:$PATH

Test the poetry install:

poetry --version

Create project directory and initialize Git

git init

Add Remote Origin

git remote add origin git@github.com:adrianmeraz/marz-explorer.git

Pull repo

git pull

Create new branch and switch to branch

git checkout -b <BRANCH_NAME>

Delete local branch

git branch -d <BRANCH_NAME>

Use .env example to set environment variables.

NOTE

When deploying to remote environments, the environment variables must be set in Git secrets, as well as the lambda deployment.

DATABASE_URL should be set to postgres://postgres:postgres@localhost:5432/postgres

This should match values in the github actions yml

Install poetry with instructions HERE

Verify the installation with a version check

poetry --version

If command not found, set the path variable:

source $HOME/.poetry/env

poetry install

import secrets

print(secrets.token_urlsafe())

Add to .env file as SECRET_KEY environment variable

Right click Login/Group Roles -> Create -> Login/Group Role

1. Click General Tab -> Set Name to "redexapi"

2. Click Definition Tab -> Set Password to "redexapi"

3. Click Privileges Tab -> Toggle the following:

   1. "Can Login" = On
   2. "Create databases" = On

A new user with the name "redexapi" will be added to the "Login/Group Roles" list

Right click on Databases -> Create -> Database

1. Click General Tab -> Set Database to "redexapi"

2. Set Owner to "redexapi"

Name the database "redexapi"

Click "Save"

sudo apt update
sudo apt install postgresql postgresql-client

systemctl status postgresql.service

NOTE: Don't use the @ symbol in the password!

sudo su - postgres
psql -c "alter user postgres with password '<DB_PASSWORD>'"

psql

\conninfo

Details should look similar to this:

You are connected to database "postgres" as user "postgres" via socket in "/var/run/postgresql" at port "5432".

Replace placeholder values with real values

sudo -u postgres psql
postgres=# create database <DB_NAME>;
postgres=# create user <DB_USERNAME> with encrypted password '<DB_PASSWORD>';
postgres=# grant all privileges on database <DB_NAME> to <DB_USERNAME>;
postgres=# ALTER USER <DB_USERNAME> CREATEDB;

To Delete the local database, run:

postgres=# DROP DATABASE <DB_NAME>;

postgres://<DB_USERNAME>:<DB_PASSWORD>@localhost:5432/<DB_NAME>

The initial database url will be:

postgres://postgres:postgres@localhost:5432/postgres

Run the command from the project root to create the database and service user

poetry run python manage.py create_db --db-url="<DB_INSTANCE_URL>" --db-name="<NEW_DB_NAME>" --db-username="<NEW_DB_USERNAME>" --db-password="<NEW_DB_PASSWORD>"

poetry run python manage.py makemigrations
git add .
poetry run python manage.py migrate
poetry run python manage.py createsuperuser

Set the following environment variables:

DJANGO_SUPERUSER_EMAIL DJANGO_SUPERUSER_USERNAME DJANGO_SUPERUSER_PASSWORD

poetry run python manage.py makemigrations
git add .
poetry run zappa manage <STAGE_NAME> "migrate"
poetry run zappa manage <STAGE_NAME> "createsuperuser --noinput"

poetry init

poetry install

poetry update

poetry update <PACKAGE_NAME>

poetry show --tree

poetry env list

poetry env info

poetry env remove <ENV_NAME>

poetry cache clear . --all

which poetry

After any Model Updates:

1. Create migrations
2. Add migrations to git
3. Migrate to run DB changes

poetry run python manage.py makemigrations
git add .
poetry run python manage.py migrate
poetry run python manage.py createsuperuser

Specify settings with --settings

poetry run python manage.py test --settings=config.settings.local --no-input --parallel

To run against a single module, add the module name:

poetry run python manage.py test djstarter.tests.test_views --settings=config.settings.local --no-input --parallel

NOTE Tests must be isolated and able to run independently! The --parallel flag causes incorrect values

coverage run manage.py test --settings=config.settings.local --keepdb

Must be run after coverage tests have been run

coverage report

coverage html

This creates the directory coverage html. Open the index.html to see the full report

poetry build
poetry publish

If the numbers reported aren't what's expected, or tests are missing, verify that an empty __init__.py is in the tests directory for each app.

Contributions are encouraged and welcome!

The general steps to contribute are:

1. Create an issue for a feature/bug, if not already created
2. Create a feature branch with the issue in the name
   1. Example: If the issue is #123, create the branch as feature/DC-123
3. Write Tests
4. Write Code - All code must have tests and cannot lower coverage!
5. Verify all tests pass
6. Pull all and merge all changes from the dev branch
7. Create a pull request to merge into the dev branch