# Development Setup (one-time setup for external devevelopment) ## Quick Setup (Recommended) For a streamlined setup experience, we provide an automated setup script that handles most of the configuration for you. ### Prerequisites 1. Fork the repository on GitHub (see manual steps below for details) 2. Clone your fork locally 3. Ensure Python 3.11 is installed ### Automated Setup After cloning your fork, run the setup script from the project root: ```bash cd home-information ./deploy/dev-setup.sh ``` This script will: - Configure git settings and remotes - Generate environment variables - Create and activate a Python virtual environment - Install all required packages - Initialize the database - Run validation tests The script is interactive and will prompt you for necessary information. It's safe to run multiple times if needed. ## Manual Setup (Alternative) If you prefer to set up manually or need more control over the process, follow these detailed steps (details below): ``` git clone https://github.com/${YOURUSERNAME}/home-information.git cd home-information make env-build-dev python3.11 -m venv venv . ./init-env-dev.sh pip install -r src/hi/requirements/development.txt cd src ./manage.py check ./manage.py migrate ./manage.py hi_createsuperuser ./manage.py hi_creategroups ./manage.py runserver ``` ## Fork the Repository - Sign into your GitHub account (required). - Go to the main repository on GitHub: https://github.com/cassandra/home-information - Click the "Fork" button in the upper-right corner. (You will be forking from the `staging` branch.) - This creates a copy of the repository in the your GitHub account (keep same name if you can for simplicity). - The forked repo will be located at https://github.com/${YOURUSERNAME}/home-information.git (if you kept the same repo name). ## Local Repository Setup Decide where you want to download the code to (adjust the following): ``` shell PROJ_DIR="${HOME}/proj" mkdir -p $PROJ_DIR cd $PROJ_DIR ``` Clone your fork to your local development environment: ``` shell git clone https://github.com/${YOURUSERNAME}/home-information.git # Or use the SSH URL if you have SSH keys set up: git clone git@github.com:${YOURUSERNAME}/home-information.git ``` Now change into that directory and configure the repo including adding the source as the "upstream" target: ``` shell cd home-information git config --global user.name "${YOUR_NAME}" git config --global user.email "${YOUR_EMAIL}" git remote add upstream https://github.com/cassandra/home-information.git ``` Your "origin" should already be pointing to your forked repository, but check this and the "upstream" settings: ``` shell git remote -v # Expect origin https://github.com/${YOURUSERNAME}/home-information.git (fetch) origin https://github.com/${YOURUSERNAME}/home-information.git (push) upstream https://github.com/cassandra/home-information.git (fetch) upstream https://github.com/cassandra/home-information.git (push) ``` If your origin is not set properly, re-verify after setting with: ``` shell git remote add origin git@github.com:${YOURUSERNAME}/home-information.git # If no SSH keys were added to GitHub, you'll need this instead: git remote set-url origin https://github.com/${YOURUSERNAME}/home-information.git ``` ## Environment Setup Generate the environment variable file and review with the command below. The file will contain sensitive secrets and are stored in a `.private` directory. Also note that administrative credentials created during this next step. ``` shell make env-build-dev ``` This generates an environment variable file that we "source" before running: ``` $PROJ_DIR/.private/env/development.sh ``` This `.private` directory and its files should not be checked into the code repository. There is an existing `.gitignore` entry to prevent this. The adminstrative credentials generated can also be seen in that file. Next, create the Python virtual environment. ``` shell cd $PROJ_DIR python3.11 -m venv venv ``` Now source the environment and virtual environment with this convenience script: ``` shell . ./init-env-dev.sh ``` In the future, just source'ing this script is all you need to set things up for development (virtual env and env vars). Next, install all the app's required Python packages (make sure you are in the virtual env). ``` shell pip install -r src/hi/requirements/development.txt ``` ### App and Database Initializations Initialize the database and add the admin users and groups. ``` shell cd $PROJ_DIR/src ./manage.py check ./manage.py migrate ./manage.py hi_createsuperuser ./manage.py hi_creategroups ``` It is a good idea to run the tests to validate that you can and that the installation seem fine. ``` shell cd $PROJ_DIR/src ./manage.py test ``` ### Running Ensure that a local Redis server is running (see the Dependencies page for installation instructions). Note: Redis is only a manual dependency for local development — Docker deployments bundle it automatically. Then: ``` shell cd $PROJ_DIR/src ./manage.py runserver ``` Then, visit: [http://127.0.0.1:8411](http://127.0.0.1:8411) to access the app. ## Daily Development Commands Once your environment is set up, these are the common commands for daily development work: ### Environment Activation ```bash # Daily development setup (run this first each day) . ./init-env-dev.sh # Sources virtual env and environment variables ``` ### Django Management ```bash cd $PROJ_DIR/src # Database operations ./manage.py migrate ./manage.py makemigrations ./manage.py check # Testing ./manage.py test # Run all tests ./manage.py test weather.tests # Run specific app tests # User management ./manage.py hi_createsuperuser ./manage.py hi_creategroups # Development server ./manage.py runserver # Runs on http://127.0.0.1:8411 ``` ### Code Quality ```bash # Linting and formatting (from development.txt requirements) black src/ # Format code flake8 --config=src/.flake8-ci src/ # Lint code with CI configuration autopep8 --in-place --recursive src/ # Auto-format ``` ### Docker Operations ```bash # Build and run in containers make docker-build make docker-run-fg # Foreground make docker-run # Background make docker-stop ``` ### Documentation Use `grip` for previewing GitHub markdown documents locally. ``` sudo apt install grip cd $PROJ_DIR grip # Then visit: http://localhost:6419 ``` ## Getting Started If you want to familiarize yourself with how to use the app before diving into the code, see the [Getting Started Page](../GettingStarted.md). A look through these docs might also be a good starting point: - [Data Model](shared/data-model.md) - [Architecture](shared/architecture-overview.md)