Skip to content

KryptonChicken/soundzcape

Repository files navigation

Soundzcape

CircleCI TravisCI Gitter XO

Soundzcape is a 2D music platformer with game maps procedurally generated from sound waves. This is an open source project licensed under Apache 2, any contributions are welcome!

We have a Gitter channel here, feel free to talk to us!

Development

We use Docker to manage our development, continuous integration and production environments. Each part of the application stack is isolated in a container and can be controlled as a group using docker-compose. You can start the development server using the following command:

$ docker-compose up --build

You only need to build the docker image for the first time, which will take a few minutes. The containers can then be started with just docker-compose up. With the development environments set up, you can visit http://localhost to see your changes in real time. You can invoke commands in a specific containers using the run option:

# Drop into a shell:
$ docker-compose run nginx sh

# Run frontend test (xo-lint):
$ docker-compose run webpack npm run test

The names of the containers are nginx, webpack and python.

Detach mode

You will be attached to the containers automatically when using the up command. If you prefer the containers to stay in the background:

$ docker-compose up --build -d

To stop and remove the running containers:

$ docker-compose down --rmi local -v