Skip to content

AgenciaMonk/laravel-api-starter-kit

Repository files navigation

Laravel Starter API

Build Status StyleCI

Laravel Starter API will provide you with the tools for making API's that everyone will love.

Documentation here

Up and Running

  • Clone this repository $ git clone git@github.com:AgenciaMonk/Laravel-Api-Starter-Kit.git
  • Create the env file $ cp .env.example .env
  • Generate a random string with 32 characters for the APP_KEY variable on your .env file.

Using PHP built-in server

  • Create the database file $ touch database/database.sqlite
  • Install composer dependencies $ composer install
  • Generate a JWT secret key $ php artisan jwt:secret
  • Migrate the database and run the seeders $ php artisan migrate --seed
  • Start the server $ php -S localhost:8000 -t public

Using Docker

  • Start docker $ docker-compose up -d
  • Uncomment the database variables at the .env file.
  • Install composer dependencies $ docker-compose run app composer install
  • Generate a JWT secret key $ docker-compose run app php artisan jwt:secret
  • Migrate the database and run the seeders $ docker-compose run app php artisan migrate --seed

Visit http://localhost:8000

Contributing

  • Fork it!
  • Create your feature branch from master: $ git checkout -b feature/my-new-feature
  • Write your code, comment your code, test your code
  • Commit your changes $ git commit -am 'Add some feature'
  • Push to the branch $ git push origin feature/my-new-feature
  • Submit a pull request to master branch

Testing

$ composer test

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Laravel API starter Kit will provide you with the tools for making API's that everyone will love

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages