The ArQive Docker Dev Environment

This bash script creates Docker containers for the backend and frontend of www.thearqive.com Senior Design Project that can be used for a working environment. Docker was chosen for this project so that different software versions could easily be substituted and built to see how they work with eachother. The project is designed to be forked, each user can configure the containers to fit the stack they are working on and share that with others.

Each contains the repo, Dockerfile and docker-compose.yml that pertains to their respective software stack. These files are plain text and easy to modify, read up on the Docker and docker-compose documentation to make changes. The repository and branch can be set in the ./config.template .

The Django and the backend requires some configuration and this project attempts to automate that. However it might not always work in practice so an explanation of what's going on:

Getting Started

---

Prerquisites

• A Bash shell to run the script
  • For Windows:
    WSL 2.0 using Ubuntu
    git bash
    CIGWYN
    
  • For Mac and Linux: Built-in bash shell

• git
• Docker and docker-compose
• A database dump from production:
  • placed at: dev/source/defaultdb.sql

Installation

git clone github.com/Shramster/arqive-dev-docker
cd arqive-dev-docker/

Edit the ./config.template to reflect the Repo and Branches you are using and rename it to config. Then run:

arqive build

This will clone the backend and frontend repos, build their containers and start the development servers the containers will show up in Docker Desktop.

If everything ran correctly the app served at 127.0.0.1:3000 should look and act like www.thearqive.com. Navigate to here with your web browser to confirm:

127.0.0.1:8000   Backend Development Server
127.0.0.1:3000   Frontend Development Server 

Organization:

After running the directory structure works like this:

arqive-dev-docker
.
│    
├── thearqive-backend/	// Backend Repo 
│    
├──  arQive-frontend/	// Frontend Repo
│    
├── dev
│   ├── docker		// Contains: all commands used by arqive 
│   └── source		// Contains: Dockerfiles, docker-compose.yml, create_api_key.py etc
│       │		 
│       ├── backend
│       └── frontend
│    
├── README.md		// This File
├── arqive-cli		// Execuatable
└── config.template		// Config file that needs to be edited and renamed to => `config`

Trouble shooting

Backend

./dev/docker/buildbackend.sh

• docker-compose exec web python GlobalTraqs/manage.py createsuperuser --noinput

  This creates a super user for the Django admin page, the password and username are configured in the backend docker-compose.yml. If you can't login to the Django admin page, spin up the backend container and run this command.

• docker-compose exec web python GlobalTraqs/manage.py shell -c "exec(open('create_api_key.py').read())" > .env

  Creates a .env file with an API key for the frontend that must be copied into the frontend directory so Node can source it when it boots up. If the webpage is loading and displaying the map but not the pins this may be the culprit. Spin up the backend and try running this on it again or check whats in the .env file.

Postgres:

The postgres config is contained in the docker-compose.yml and is easy to change.

• defaultdb.sql is imported into the container via the ./thearqive-backend/docker-compose.yml
• user and password are defined in the backend ./thearqive-backend/docker-compose.yml

Further Readding / Documentation:

• Docker
• docker-compose
• WSL 2.0
• Django Documentation
• Node Live server
• Docker-compose CLI cheat-sheet

TODO:

• Allow rebuilding of frontend and backend separately