Burning Flipside Developer

This repo includes a docker compose symphony to allow you to create a development sandbox of Burning Flipside web applications.

This project has been built and tested using both Mac OSX and Debian linux systems. If you use a different distribution you may need to make modifications. PRs are always welcome.

If your workstation runs Windows

To run the latest docker on window requires Windows 10 Professional.

If you are running another version of windows we recommend creating a linux virtual machine to work from.

If your workstation runs OSX or Linux

You can run the latest docker with little restriction.

You still might find advantages to working in a virtual machine.

Creating a Virtual Machine

If you create your virtual machine using these instructions you can skip the prerequisites below. https://bhedana.gitbooks.io/burner-code-school-sandbox-provisioning/content/ (I recommand creating a VM with 32gb disk for this project)

prerequisites

• Install Docker
• Install Docker Compose

setup

1. Sign up for GitHub Account

2. Fork our repos

• https://github.com/BurningFlipside/CommonCode
• https://github.com/BurningFlipside/Profiles
• https://github.com/BurningFlipside/Registration
• https://github.com/BurningFlipside/SecureFramework
• https://github.com/BurningFlipside/ThemeRegistration
• https://github.com/BurningFlipside/Tickets
• https://github.com/BurningFlipside/VolunteerSystem

1. clone this repo to your workstation

git clone https://github.com/BurningFlipside/DevSandbox && cd DevSandbox

1. run setup helper script

./setup.sh

spin up services

docker instances will run your services but will read source from local repos in ./src/*

change source code and refresh browser to immediately see your changes

if you have mysql, ldap, or mongo database services running on your development machine you will need to stop those services while docker-compose is running.

bin/compose up

now point your web browser to https://localhost:3300 open up repos in src/* to make changes

spin down services

bin/compose down