{"id":15103746,"url":"https://github.com/abrahamuchos/restaurant-tdd-api","last_synced_at":"2025-04-05T12:26:46.521Z","repository":{"id":255259159,"uuid":"845731016","full_name":"abrahamuchos/restaurant-tdd-api","owner":"abrahamuchos","description":"Restaurant API Rest - Laravel 11  TDD","archived":false,"fork":false,"pushed_at":"2025-01-15T21:14:41.000Z","size":703,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-10T23:51:12.804Z","etag":null,"topics":["api-rest","jobs","json-web-token","jwt","jwt-authentication","laravel-api","laravel-jobs","laravel11","phpunit","postgres14","postgresql","tdd-laravel","test-driven-development"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abrahamuchos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-08-21T20:21:57.000Z","updated_at":"2025-01-15T21:19:25.000Z","dependencies_parsed_at":"2024-08-28T22:39:37.184Z","dependency_job_id":"9fd9542a-0598-4cf7-b1fb-2a21a7f24976","html_url":"https://github.com/abrahamuchos/restaurant-tdd-api","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"8855ec9f1949267db43740f9eaf1d2f38bba6fcc"},"previous_names":["abrahamuchos/restaurant-tdd-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abrahamuchos%2Frestaurant-tdd-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abrahamuchos%2Frestaurant-tdd-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abrahamuchos%2Frestaurant-tdd-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abrahamuchos%2Frestaurant-tdd-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abrahamuchos","download_url":"https://codeload.github.com/abrahamuchos/restaurant-tdd-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247335639,"owners_count":20922475,"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":["api-rest","jobs","json-web-token","jwt","jwt-authentication","laravel-api","laravel-jobs","laravel11","phpunit","postgres14","postgresql","tdd-laravel","test-driven-development"],"created_at":"2024-09-25T19:41:50.866Z","updated_at":"2025-04-05T12:26:46.493Z","avatar_url":"https://github.com/abrahamuchos.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Restaurant API\n\nUsing Laravel 11 and applying TDD, I have built a API REST that allows restaurant owners to digitize their businesses. \nThe platform offers functionalities such as restaurant registration, menu management, and QR code generation for a more \ninteractive customer experience.\n\n## ✅ Features\n\n- Auth users\n- Show restaurants\n- Show restaurant by id\n- Create restaurants\n- Update restaurant\n- Delete restaurants\n- Show menus\n- Show menu by id\n- Create menus\n- Update menu\n- Delete menus\n- Show dishes\n- Show dish by id\n- Create dish\n- Update dish\n- Delete dish\n- Generate QR code\n- Show QR code\n\n## ⚙️ Tech Stack\n\n- Laravel 11\n- tymon/jwt-auth 2.*\n- giauphan/laravel-qr-code 1.*\n- Postgres 14\n\n\n## 💾 Installation\n\nInstall and run\n\n1. Clone and move to folder\n```bash\n$ git clone git@github.com:abrahamuchos/restaurant-tdd-api.git\n$ cd restaurant-tdd-api\n```\n\n2. Install dependencies\n```bash\n$  composer install\n```\n3. Create a copy of the `.env.example` file and rename it to `.env`. Next, configure the necessary environment variables.\n\n4. Run `php artisan jwt:secret` to generate a secret key for JWT. This will update your `.env` file with something like JWT_SECRET=foobar\n\n5. Generate an application key by running `php artisan key:generate`.\n\n5. Run `php artisan migrate` to create the database tables.\n\n6. Run `php artisandb:seed` to create dummy data and admin user.\n\n7. Run `php artisan serve` to start the Laravel development server.\n\n8. Run `php artisan storage:link` to start the Laravel development server.\n\nTo run Jobs (Qr Image Generator) `php artisan queue:work` to start the Laravel queue worker (Check POST Menu endpoint)\n\n## 📦 Environment Variables\n\nTo run this project, you will need to add the following environment variables to your .env file\n\n```\nDB_HOST\nDB_PORT\nDB_DATABASE\nDB_USERNAME\nDB_PASSWORD\nJWT_SECRET\n```\n\n## 🗂️ Docs\n\n[Documentation Restaurant TDD API - Postman](https://documenter.getpostman.com/view/6168326/2sAYQZGrZR)\n\nYou can find a .json with the endpoints in `/docs/Restaurant TDD.postman_collection.json`\n\n## 🧑‍💻 Authors\n\n- [@abrahamuchos](https://github.com/abrahamuchos)\n- [Contact mail](mailto:j.abraham29@gmail.com)\n\n## 📄 License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabrahamuchos%2Frestaurant-tdd-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabrahamuchos%2Frestaurant-tdd-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabrahamuchos%2Frestaurant-tdd-api/lists"}