https://github.com/edumarques/orders-api
Simple API that manages placement of orders. It also supports voucher handling. Developed on Symfony.
https://github.com/edumarques/orders-api
Last synced: 9 months ago
JSON representation
Simple API that manages placement of orders. It also supports voucher handling. Developed on Symfony.
- Host: GitHub
- URL: https://github.com/edumarques/orders-api
- Owner: edumarques
- License: mit
- Created: 2023-06-09T22:26:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T18:16:58.000Z (almost 3 years ago)
- Last Synced: 2025-06-10T13:49:03.586Z (10 months ago)
- Language: PHP
- Homepage:
- Size: 143 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Orders API
Simple API that manages placement of orders. It also supports voucher handling.
[](https://app.circleci.com/pipelines/github/edumarques)
[](https://codecov.io/gh/edumarques/orders-api)
## 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
sh docker/setup.sh
docker-compose build --pull --no-cache
docker-compose up --detach
```
## Documentation
There two endpoints that provide the API documentation, after running the project. We use Swagger and OpenAPI
specification.
Interactive documentation:
```text
/doc
```
JSON documentation:
```text
/doc.json
```
#### There is also a [Postman collection](./docs/postman_collection.json) already set up.
#### The current API's database model is represented in this [ER diagram](./docs/er_diagram.png).
## Useful tips
#### List of available commands using *Make*:
```text
👷 Makefile
help Outputs this help screen
🐳 Docker
setup Sets up dependencies for environment
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
bash Connect to a container via BASH
php-sh Connect to the PHP FPM container via SH
php-bash Connect to the PHP FPM container via BASH
✅ 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-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'
🎶 Symfony
sf List all Symfony commands or pass the parameter "c=" to run a given command, example: make sf c=about
cc Clear the cache
migrations-diff Generate diff of migrations based on entities
migrations-migrate Execute all migrations
```