{"id":13828581,"url":"https://github.com/mstaack/lumen-api-starter","last_synced_at":"2025-07-09T06:32:16.065Z","repository":{"id":57021558,"uuid":"54744673","full_name":"mstaack/lumen-api-starter","owner":"mstaack","description":"Quickstarter for Lumen","archived":true,"fork":false,"pushed_at":"2019-07-10T13:04:35.000Z","size":254,"stargazers_count":60,"open_issues_count":1,"forks_count":19,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-08T03:39:47.993Z","etag":null,"topics":["api","json","laravel","lumen-framework","php","php7"],"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/mstaack.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}},"created_at":"2016-03-25T20:06:29.000Z","updated_at":"2023-01-28T15:33:23.000Z","dependencies_parsed_at":"2022-08-23T12:20:37.937Z","dependency_job_id":null,"html_url":"https://github.com/mstaack/lumen-api-starter","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstaack%2Flumen-api-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstaack%2Flumen-api-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstaack%2Flumen-api-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstaack%2Flumen-api-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mstaack","download_url":"https://codeload.github.com/mstaack/lumen-api-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225492420,"owners_count":17482869,"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","json","laravel","lumen-framework","php","php7"],"created_at":"2024-08-04T09:02:53.490Z","updated_at":"2024-11-20T08:30:49.552Z","avatar_url":"https://github.com/mstaack.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# Lumen 5.8 API Starter with Paseto    \n\n[![Build Status](https://travis-ci.org/mstaack/lumen-api-starter.svg?branch=master)](https://travis-ci.org/mstaack/lumen-api-starter)\n\n# Notes\n- Comes with make \u0026 route command for all your needs\n- Uses jwt token alternative **paseto**. Read [Paseto](https://github.com/paragonie/paseto)\n\n# Included Packages\n- [Clockwork](https://underground.works/clockwork/) Easier debugging with APIs\n- [PHPUnit Pretty Result Printer](https://github.com/mikeerickson/phpunit-pretty-result-printer) Nice phpunit results\n- [Collision](https://github.com/nunomaduro/collision) Better Console Error Handling\n- [Lumen Form Requests](https://github.com/pearlkrishn/lumen-request-validate) Abstract Validation \u0026 Authorization into classes\n- [Laravel Dump Server](https://github.com/beyondcode/laravel-dump-server) Dump data to the artisan server\n- [Laravel-Apidoc-Generator](https://mpociot/laravel-apidoc-generator) Generate api docs\n- [spatie/laravel-permission](https://github.com/spatie/laravel-permission) Roles \u0026 Permissions\n\n# Installation\n- run `git clone git@github.com:mstaack/lumen-api-starter.git` \n- reinit your repository with `rm -rf .git \u0026\u0026 git init`\n- run `composer install` to install dependencies (consider using homestead via `vagrant up`)\n- copy `env.example` to `.env`\n- Setup your application \u0026 auth keys with `composer keys` \u0026 check `.env`file (automatically done via composer hook)\n- run migrations \u0026 seeders with `artisan migrate --seed` (within your vm using `vagrant ssh`)\n- A default user is created during seeding: `demo@demo.com` / `password`\n- To quickly start a dev server run `./artisan serve` (or via `homestead.test` for the vm)\n- Also consider running `composer meta` when adding models for better autocompletion (automatically done via composer hook)\n- Run included tests with `phpunit` within vagrant's code directory\n- Generate your api docs with `artisan apidoc:generate` \n\n# Routes\n```\n➜  lumen-api-starter git:(update-5.8) ✗ ./artisan route:list\n+------+--------------------------------+-----------------------+-------------------------------------+-----------------+--------------------------+\n| Verb | Path                           | NamedRoute            | Controller                          | Action          | Middleware               |\n+------+--------------------------------+-----------------------+-------------------------------------+-----------------+--------------------------+\n| GET  | /                              |                       | None                                | Closure         |                          |\n| POST | /auth/register                 | auth.register         | App\\Http\\Controllers\\AuthController | register        |                          |\n| POST | /auth/login                    | auth.login            | App\\Http\\Controllers\\AuthController | login           |                          |\n| GET  | /auth/verify/{token}           | auth.verify           | App\\Http\\Controllers\\AuthController | verify          |                          |\n| POST | /auth/password/forgot          | auth.password.forgot  | App\\Http\\Controllers\\AuthController | forgotPassword  |                          |\n| POST | /auth/password/recover/{token} | auth.password.recover | App\\Http\\Controllers\\AuthController | recoverPassword |                          |\n| GET  | /auth/user                     | auth.user             | App\\Http\\Controllers\\AuthController | getUser         | auth                     |\n| GET  | /admin                         |                       | None                                | Closure         | auth, role:administrator |\n+------+--------------------------------+-----------------------+-------------------------------------+-----------------+--------------------------+\n```\n\n# Artisan Commands\n```\n➜  lumen-api-starter git:(master) ./artisan \nLaravel Framework Lumen (5.6.4) (Laravel Components 5.6.*)\n\nUsage:\n  command [options] [arguments]\n\nOptions:\n  -h, --help            Display this help message\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question\n      --env[=ENV]       The environment the command should run under\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\n\nAvailable commands:\n  clear-compiled            Remove the compiled class file\n  dump-server               Start the dump server to collect dump information.\n  help                      Displays help for a command\n  list                      Lists commands\n  migrate                   Run the database migrations\n  optimize                  Optimize the framework for better performance\n  serve                     Serve the application on the PHP development server\n  tinker                    Interact with your application\n auth\n  auth:clear-resets         Flush expired password reset tokens\n  auth:generate-paseto-key  Creates a new authentication key for paseto\n cache\n  cache:clear               Flush the application cache\n  cache:forget              Remove an item from the cache\n  cache:table               Create a migration for the cache database table\n clockwork\n  clockwork:clean           Cleans Clockwork request metadata\n db\n  db:seed                   Seed the database with records\n ide-helper\n  ide-helper:eloquent       Add \\Eloquent helper to \\Eloquent\\Model\n  ide-helper:generate       Generate a new IDE Helper file.\n  ide-helper:meta           Generate metadata for PhpStorm\n  ide-helper:models         Generate autocompletion for models\n key\n  key:generate              Set the application key\n make\n  make:command              Create a new Artisan command\n  make:controller           Create a new controller class\n  make:event                Create a new event class\n  make:job                  Create a new job class\n  make:listener             Create a new event listener class\n  make:mail                 Create a new email class\n  make:middleware           Create a new middleware class\n  make:migration            Create a new migration file\n  make:model                Create a new Eloquent model class\n  make:policy               Create a new policy class\n  make:provider             Create a new service provider class\n  make:request              Create a new form request class\n  make:resource             Create a new resource\n  make:seeder               Create a new seeder class\n  make:test                 Create a new test class\n migrate\n  migrate:fresh             Drop all tables and re-run all migrations\n  migrate:install           Create the migration repository\n  migrate:refresh           Reset and re-run all migrations\n  migrate:reset             Rollback all database migrations\n  migrate:rollback          Rollback the last database migration\n  migrate:status            Show the status of each migration\n queue\n  queue:failed              List all of the failed queue jobs\n  queue:failed-table        Create a migration for the failed queue jobs database table\n  queue:flush               Flush all of the failed queue jobs\n  queue:forget              Delete a failed queue job\n  queue:listen              Listen to a given queue\n  queue:restart             Restart queue worker daemons after their current job\n  queue:retry               Retry a failed queue job\n  queue:table               Create a migration for the queue jobs database table\n  queue:work                Start processing jobs on the queue as a daemon\n route\n  route:list                Display all registered routes.\n schedule\n  schedule:run              Run the scheduled commands\n```\n\n# Generated Docs Screenshot\n\n![image](https://user-images.githubusercontent.com/10169509/54946091-a154de00-4f37-11e9-8a96-3ce71c189b6d.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstaack%2Flumen-api-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmstaack%2Flumen-api-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstaack%2Flumen-api-starter/lists"}