Development Environment
Create a containerized development environment so you can build, test and contribute to Speedtest Tracker.
Last updated
Create a containerized development environment so you can build, test and contribute to Speedtest Tracker.
Last updated
Speedtest Tracker is built on the framework, this means we get to use some awesome 1st party packages like to create a local containerized development environment.
These directions will walk you through the steps of setting up that environment.
First let's clone the to your machine, I prefer so that command is included below.
Next we need to make a copy of .env.example, the environment file is what Laravel uses.
You will copy and fill in the following Environment Variables
We'll use a temporary container to install the Composer dependencies for the application.
To start up the environment we can now use the Sail binary that is included with the package to start our development environment.
To start up the environment we need to make a database
As well need to make the needed tables etc in the database.
We will need to install the needed NPM assets
You can reset your development environment at any time by re-running a fresh migration:
Processes like running a speedtest and sending notifications are offloaded to be run by a worker process. If you're testing or developing anything requiring the queue jobs be processed run the command below.
To keep PHP's code style consistent across multiple contributors a successful lint workflow is required to pass. Check your code quality locally by running the command below and fixing it's recommendations.
When you're done in the environment you can stop the containers using the command below.
We utilize for a local development environment this way on your machine the only requirements are Git and Docker. To build the development environment run the commands below.