To spin up a working copy of this site on your local machine, you'll need a few important pieces before getting started:
- Install Docker Community Edition
- Windows users will need to configure Docker to access local drives
- Clone this repository to your local machine:
git clone git@github.com:ynotradio/site.git
- In your terminal,
cd
to the root of this project directory - Replace
/src/db/docker/ynot_db.sql
with the latest copy of the YNotRadio.net MySQL database. - Run
docker-compose up
to build the Docker images and run the [https://docs.bitnami.com/containers/how-to/create-amp-environment-containers/](Apache, PHP and MySQL) services - Once the installation is finished, a site will be available for you to visit at: http://localhost:8080
If you would like to run Docker without seeing the terminal output, use docker-compose up -d
to run the containers in the background. Some helpful documentation about docker-compose
can be found in the Docker Docs.
If you run into challenges with a Docker container, this is a helpful cheatsheet for removing images and volumes before starting over.
- From the root of the project, use
docker run --rm --volume $(pwd):/app vfac/php7compatibility 7.4 ./src -d memory_limit=1G --extensions=php
to see errors in the PHP code.
Access PHPMyAdmin in development by visiting http://localhost:8181
- When you are finished development, run
docker-compose down
from your terminal to halt the containers.
Please open an issue for support.
Please contribute using Gitflow Workflow. Create a branch, add commits, and open a pull request.
Branch names should follow the following formats:
- New features / additions:
feature/new-feature-name
- Bugfixes:
fix/bugfix-description
- Releases:
release/release-2.0.0
If you solve a tricky bug, the next person who works on this codebase will appreciate you including a Stack Overflow or Github Issue link to help understand why the change was made!