[![CircleCI Status](https://circleci.com/gh/CSU-Booking-Platform/application.svg?style=shield)](https://circleci.com/gh/CSU-Booking-Platform/application)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=CSU-Booking-Platform_application&metric=alert_status)](https://sonarcloud.io/dashboard?id=CSU-Booking-Platform_application)
A tool to improve location and equipment reservation workflow for clubs, students and faculty members.
You must have the ZenHub Extension installed for your browser to properly our issue board and sprints.
Apache
/ Nginx
/ Caddy
Postgres
> 12PHP
>= 7.4bcmath, pgsql
xdebug
is always a plusUse any XAMPP/ MAMP like tools, I recommended laragon
on win or valet
/valet+
on mac
composer fresh
, it will run a batch of the starter commands..env
and configure it to work with what you need, namely the DB connection.env
composer mfs
php artisan self-diagnosis
php artisan migrate:fresh --seed
(composer mfs
for short) to quickly recreate the db tables and seed it with random dataphp artisan db:seed
composer fresh
or composer reset
if you think its related to composer dependenciesnpm run dev
or npm run watch
for frontend dev build, the watch command will recompile when files are changedNavigate to your local site. Varies depending on web server. Could be localhost:8000, could be csu.test 🤷
Look at routes/api.php
file for a quick view of api specific routes that are defined for this application.
Postman or Insomnia are good tools for building
out api endpoint collections.
Tinker is the primary tool for testing queries, php logic, and debugging weird code... Basically your best friend.
Open it with php artisan tinker
. It's an interactive repl php shell that makes it quick & easy to dumbass proof your code.
Yu can run php artisan test
to run all the test suites.
Normally your IDE can be configured to run specific tests or all of them. Refer to specific IDE documentation.
Again, your IDE should recognize these tests and help you create a run configuration for those. To run everything from console use npm run test
.
For PHP, make sure your install the XDebug PHP extension and configure it properly. I like to use remote autostart to avoid hassle and quickly debug my code.
We'll be using the laravel framework for this project. A good place to start learning all of this scary new tech is Laracasts, specifically the laravel from scratch series & Vue 2 Step by step.
This booking application is open-sourced software licensed under the MIT license.