Built using the Laravel framework
- Getting Started
- Prerequisites
- Serving the application
- Additional program set-up
- Development cycle commands
- Bugs and issues
- License
Make sure you meet the necessary Prerequisites in order to start developing on your machine.
- Git
- Docker
- Docker-Compose
- Favorite Text Editor or IDE
To begin, navigate to the program root on your favorite terminal and run the following:
docker-compose up -d
This will build and run the following containers:
- The Laravel web service, named checkpoint-server
- Composer service, which installs composer and runs
$ composer install - A database administration GUI - Adminer, named checkpoint-adminer
- MySQL service, named checkpoint-mysql
docker-compose.yml file, you will find the database configuration that needs to be included in the program's .env file. After you have done this you should be able to type localhost:8080 on your favorite browser and see the application's landing page.
To end the serve
docker-compose down
To get into the docker container run
docker exec -it checkpoint-server bash
Once you have successfully served the application, you will need to seed the database. In order to do that you need to navigate to the program root on your favorite terminal and run the following:
$ docker exec -it checkpoint-server bash
This will drop you into the checkpoint-server container which allows you to run any commands inside the web server. Since we are seeding the database for the very first time, we want to run the following command:
$ php artisan migrate:refresh --seed
$ php artisan passport:install
When in doubt.
composer dump
If you discover a bug and or issue within the application, please create a JIRA ticket with the BUG prefix. In addition, please list the necessary steps to reproduce the bug in the description.
Checkpoint is open-sourced software licensed under the GNU General Public License v3+. A copy can be found in the COPYING file.
The Laravel framework is open-sourced software licensed under the MIT license.