https://github.com/edumarques/parking-lot
Simple software solution that enables management of a parking lot.
https://github.com/edumarques/parking-lot
Last synced: 6 months ago
JSON representation
Simple software solution that enables management of a parking lot.
- Host: GitHub
- URL: https://github.com/edumarques/parking-lot
- Owner: edumarques
- License: mit
- Created: 2023-06-16T17:02:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-17T17:49:06.000Z (over 2 years ago)
- Last Synced: 2025-06-10T13:49:03.589Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 674 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Parking Lot Manager
Simple software solution that enables management of a parking lot.
[](https://app.circleci.com/pipelines/github/edumarques)
[](https://codecov.io/gh/edumarques/parking-lot)
## Installation
The project can be installed and run using *Docker* and *docker-compose*.
To install *Docker*, visit its [official page](https://docs.docker.com/engine/install/).
And to install *docker-compose*, follow [these steps](https://docs.docker.com/compose/install/).
To help manage the project and execute commands in an quicker way,
there is a set of [Make](https://www.gnu.org/software/make/) targets already configured.
Set up and run the project just by running one of the following sets of commands:
```sh
make start
```
or
```sh
docker-compose build --pull --no-cache
docker-compose up --detach
```
## Basic usage
To run the manager, just execute one of the following commands:
```sh
make parking-lot-manager
```
or
```sh
docker-compose exec app bin/console parking-lot:manager
```
## Demo
## Useful tips
#### List of available commands using *Make*:
```text
--- Makefile ---
help Outputs this help screen
--- Docker ---
build Builds container(s)
up Start container(s)
up-d Start container(s) in detached mode (no logs)
start Set up, build and start the containers
stop Stop container(s)
down Stop and remove container(s)
logs Show logs
logs-f Show live logs
ps Show containers' statuses
sh Connect to a container via SH
php-sh Connect to the PHP FPM container via SH
--- Code Quality ---
phpcs Run PHP Code Sniffer
phpcs-fix Run PHP Code Sniffer (fix)
phpstan Run PHPStan
lint Run PHP Code Sniffer and PHPStan
test Run tests, pass the parameter "args=" to run the command with arguments or options
test-pretty Run tests in a pretty way, pass the parameter "args=" to run the command with arguments or options
test-cov Run tests and generate coverage report
--- Composer ---
composer Run composer, pass the parameter "c=" to run a given command, example: make composer c='req symfony/orm-pack'
--- App ---
console List all application commands or pass the parameter "c=" to run a given command, example: make command c=about
parking-lot-manager Run the Parking Lot Manager
```