Skip to content

README.md

Latest commit

 

History

History
126 lines (88 loc) · 3.96 KB

README.md

File metadata and controls

126 lines (88 loc) · 3.96 KB

Leverage Development Environment

This project provides configurations to run the leverage API and database in a dockerized environment for simple cross-platform development and testing.

Creating Local Repository

Create local repository of leverage-devbackend on your computer. You can follow these instructions if not familiar with git: https://services.github.com/on-demand/github-cli/clone-repo-cli

Before Getting Started

The DB container needs a SQL script to bootstrap the database with. Place a database dump in volumes/db/docker-entrypoint-initdb.d to have the DB bootstrap itself with that dump. To get the database dump file - search for leverage_philly file on leverage slack channel. The DB will bootstrap that data into a database named "leverage", which is accessible by a user:password combination of "leverage:leverage".

Getting Started

Run all three commands the first time you run, or any time you pull the latest from git (if you are using Windows make sure you run them in docker terminal after you cd into your local repository folder from the above step). If it's not your first run - you only need to run the 'up' command:

git submodule update --init
docker-compose build
docker-compose up -d

Running Docker

After launching Docker :

docker images

See available images with the following command (but only launch containers with the docker-compose command above):

docker images

The docker-compose command above launches the docker containers that Leverage uses. See what containers are running with:

docker ps

Get the IP address of the containers with with:

docker inspect CONTAINER_ID

If you run windows try the following command to get IP address:

docker-machine ip default

Connect to a command line interface on running container with:

docker exec -it CONTAINER_ID /bin/bash

Connect to MySQL container from command line

mysql -u leverage -p -h 0.0.0.0 -P 5220

Connect to the container for leverage-api. If you type 'ls' you will see all the files from the master branch of the api repository. To leave the docker container, type 'exit' -- but note that this command does not stop the container!

Tear down Docker containers

docker-compose down

Accessing phpmyadmin leverage database in a browser

Type IP address of the container from the step above ':' port number. Port number comes from docker-compose.yml in leverage-devbackend folder and can also be found running docker inspect for phpmyadmin container. Use user:password combination of "leverage:leverage"

Troubleshooting

Report any issues you run into setting up the environment so we can document them here!

Testing DB Changes

Anytime changes are made to the database schema (or data itself), the db container will need to be destroyed and re-created with the new data. The steps to do so are as follows:

  1. Remove old SQL script from volumes/db/docker-entrypoint-initdb.d
  2. Add new SQL script to volumes/db/docker-entrypoint-initdb.d
  3. Stop and remove the db container (docker-compose down)
  4. Create new db container (docker-compose up -d)

Testing API Changes

Anytime changes are made to the API, the leverage-api image will need to be rebuilt, then the api container will need to be destroyed and recreated based on the new image. The steps to do so are as follows:

  1. Build new leverage-api container (docker-compose build)
  2. Stop and remove the api container (docker-compose down)
  3. create new api container (docker-compose up)

Tidying up

To remove old builds of the leverage-api container, occasionally run docker image prune. This removes all untagged container images (full disclosure: this may remove untagged containers which were built for other unrelated projects, but untagged containers are almost always old and unwanted, so unless you know for sure you don't want to do this, you probably do).