{"id":28236662,"url":"https://github.com/edumarques/orders-api","last_synced_at":"2025-07-07T01:05:34.281Z","repository":{"id":174114029,"uuid":"651716182","full_name":"edumarques/orders-api","owner":"edumarques","description":"Simple API that manages placement of orders. It also supports voucher handling. Developed on Symfony.","archived":false,"fork":false,"pushed_at":"2023-06-12T18:16:58.000Z","size":146,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-10T13:49:03.586Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edumarques.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-06-09T22:26:47.000Z","updated_at":"2023-06-14T19:23:16.000Z","dependencies_parsed_at":"2023-07-02T12:00:21.685Z","dependency_job_id":null,"html_url":"https://github.com/edumarques/orders-api","commit_stats":null,"previous_names":["edumarques/orders-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/edumarques/orders-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edumarques%2Forders-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edumarques%2Forders-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edumarques%2Forders-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edumarques%2Forders-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edumarques","download_url":"https://codeload.github.com/edumarques/orders-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edumarques%2Forders-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263996083,"owners_count":23541399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-19T00:16:01.001Z","updated_at":"2025-07-07T01:05:34.271Z","avatar_url":"https://github.com/edumarques.png","language":"PHP","readme":"\u003cdiv align=\"center\"\u003e\n\n# Orders API\n\nSimple API that manages placement of orders. It also supports voucher handling.\n\n![GitHub](https://img.shields.io/github/license/edumarques/typed-collections)\n[![edumarques](https://circleci.com/gh/edumarques/orders-api.svg?style=shield)](https://app.circleci.com/pipelines/github/edumarques)\n[![codecov](https://codecov.io/gh/edumarques/orders-api/branch/main/graph/badge.svg?token=ABGMyvr355)](https://codecov.io/gh/edumarques/orders-api)\n\n\u003c/div\u003e\n\n## Installation\n\nThe project can be installed and run using *Docker* and *docker-compose*.\nTo install *Docker*, visit its [official page](https://docs.docker.com/engine/install/).\nAnd to install *docker-compose*, follow [these steps](https://docs.docker.com/compose/install/).\nTo help manage the project and execute commands in an quicker way,\nthere is a set of [Make](https://www.gnu.org/software/make/) targets already configured.\n\nSet up and run the project just by running one of the following sets of commands:\n\n```sh\nmake start\n```\n\nor\n\n```sh\nsh docker/setup.sh\ndocker-compose build --pull --no-cache\ndocker-compose up --detach\n```\n\n## Documentation\n\nThere two endpoints that provide the API documentation, after running the project. We use Swagger and OpenAPI\nspecification.\n\nInteractive documentation:\n\n```text\n/doc\n```\n\nJSON documentation:\n\n```text\n/doc.json\n```\n\n#### There is also a [Postman collection](./docs/postman_collection.json) already set up.\n\n#### The current API's database model is represented in this [ER diagram](./docs/er_diagram.png).\n\n## Useful tips\n\n#### List of available commands using *Make*:\n\n```text\n 👷 Makefile               \nhelp                           Outputs this help screen\n 🐳 Docker                 \nsetup                          Sets up dependencies for environment\nbuild                          Builds container(s)\nup                             Start container(s)\nup-d                           Start container(s) in detached mode (no logs)\nstart                          Set up, build and start the containers\nstop                           Stop container(s)\ndown                           Stop and remove container(s)\nlogs                           Show logs\nlogs-f                         Show live logs\nps                             Show containers' statuses\nsh                             Connect to a container via SH\nbash                           Connect to a container via BASH\nphp-sh                         Connect to the PHP FPM container via SH\nphp-bash                       Connect to the PHP FPM container via BASH\n ✅ Code Quality            \nphpcs                          Run PHP Code Sniffer\nphpcs-fix                      Run PHP Code Sniffer (fix)\nphpstan                        Run PHPStan\nlint                           Run PHP Code Sniffer and PHPStan\ntest                           Run tests, pass the parameter \"args=\" to run the command with arguments or options\ntest-cov                       Run tests and generate coverage report\n 🧙 Composer               \ncomposer                       Run composer, pass the parameter \"c=\" to run a given command, example: make composer c='req symfony/orm-pack'\n 🎶 Symfony                \nsf                             List all Symfony commands or pass the parameter \"c=\" to run a given command, example: make sf c=about\ncc                             Clear the cache\nmigrations-diff                Generate diff of migrations based on entities\nmigrations-migrate             Execute all migrations\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedumarques%2Forders-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedumarques%2Forders-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedumarques%2Forders-api/lists"}