Setup

Prerequisites

1. Install Docker:

   Download and install Docker Desktop from Docker's official site.

   Follow the installation instructions for your distribution from Docker's official site.

2. Clone the repo:

   bash git clone https://github.com/sjb-deck/deck.git

3. Move into the directory:

   bash cd deck

4. Copy the .env file into the current directory.

Running the Development Server with Docker

You can run the development server using Docker and the provided run.sh script.

1. Make the run.sh script executable:

   bash chmod +x run.sh

2. Add the following line to your /etc/hosts file:

   bash 127.0.0.1 deck-dev.nhhs-sjb.org ::1 deck-dev.nhhs-sjb.org

3. Run the script in development mode:

   bash ./run.sh

4. Visit the site at https://deck-dev.nhhs-sjb.org.

This script will build and start the Docker containers for the frontend, backend, and MySQL services.

Additional Notes

• The run.sh script will create a superuser account with the username and password defined by DEFAULT_ADMIN_USERNAME and DEFAULT_ADMIN_PASSWORD in .env.

Running tests

Backend

Running tests with test.sh

1. Make the test.sh script executable:

   bash chmod +x test.sh

2. Run the script:

   bash ./test.sh [optional_test_args]

   Example:

   bash ./test.sh accounts.__tests__.triggers.test_trigger_user_extras.TestTriggerUserExtras

3. The script will run the backend tests and output the results.

Running tests with Docker

1. Start a shell in the backend container:

   bash docker exec -it [backend_container_id] sh

2. Run the following command to run the tests:

   bash python manage.py test [optional_test_args]

3. The tests will run and output the results.

Frontend

1. Go to the frontend directory:

   bash cd frontend

2. Run the following command to run the tests:

   bash npm run test

3. The tests will run and output the results.