https://github.com/guastallaigor/laravel-backoffice-example

Laravel Backoffice Example is a Laravel simple CRUD API, with authentication login, and somewhat basic functionalities.
https://github.com/guastallaigor/laravel-backoffice-example

crud crud-api crud-application laravel laravel-api laravel-api-boilerplate laravel-backoffice

Last synced: 6 days ago
JSON representation

Laravel Backoffice Example is a Laravel simple CRUD API, with authentication login, and somewhat basic functionalities.

• Host: GitHub
• URL: https://github.com/guastallaigor/laravel-backoffice-example
• Owner: guastallaigor
• License: mit
• Created: 2018-10-02T22:36:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-31T01:41:56.000Z (about 5 years ago)
• Last Synced: 2025-04-05T14:44:34.243Z (3 months ago)
• Topics: crud, crud-api, crud-application, laravel, laravel-api, laravel-api-boilerplate, laravel-backoffice
• Language: PHP
• Homepage:
• Size: 330 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Laravel Backoffice Example





  Laravel Backoffice Example is a Laravel simple CRUD API, with authentication login, and somewhat basic functionalities.



[![Code Style](https://img.shields.io/badge/code%20style-PSR--2-orange.svg)](https://www.php-fig.org/psr/psr-2/)

[![Travis Build Status](https://travis-ci.org/guastallaigor/laravel-backoffice-example.svg?branch=master)](https://travis-ci.org/guastallaigor/laravel-backoffice-example)

[![Code Coverage](https://scrutinizer-ci.com/g/guastallaigor/laravel-backoffice-example/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/guastallaigor/laravel-backoffice-example/?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/guastallaigor/laravel-backoffice-example/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/guastallaigor/laravel-backoffice-example/?branch=master)

[![Code Intelligence Status](https://scrutinizer-ci.com/g/guastallaigor/laravel-backoffice-example/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)

> **Note:** This project is ment to be used with [Vue Backoffice Example](https://github.com/guastallaigor/vue-backoffice-example).

> It has all the functionalities that is used with this project.

> This project uses Laravel 5.7.

## Quick start

You will need Docker and Docker compose. Inside the container it has two services, one with PostgreSQL database and the other with PHP 7.2 Nginx.

Clone this repository, create a `.env` file from `.env.example` (don't forget to change to your datase connections and keys) and then run `docker-compose up`.

If it's your first time running, run `docker-compose exec app bash`. Then run `composer install`.

After you will need to run the migrations. Inside the container, run `php artisan migrate`.

If you want to run the seeds, add the `--seed` to the command above.

By default it runs on `localhost:3000`.

## API Information Table

Method | Request URL | Description

--- | --- | ---

GET | api/v1/backoffice/employee | List of employees

GET | api/v1/backoffice/employee/:id | Get one employee

POST | api/v1/backoffice/login | JWT Login

POST | api/v1/backoffice/employee | Create a new employee

POST | api/v1/backoffice/employee/active/:id | Change an employee to active

POST | api/v1/backoffice/employee/inactive/:id | Change an employee to inactive

PUT | api/v1/backoffice/employee/:id | Modify an employee data

DELETE | api/v1/backoffice/employee/:id | Delete an employee

## Demo

Want to see it running? You can check it out at https://vue-backoffice-example.herokuapp.com

Or you can just use the API at https://laravel-backoffice-example.herokuapp.com

## TODO

* [X] Add Travis CI.

* [X] Add Scrutinizer CI.

* [X] Add 90%+ test coverage.

* [ ] Add PHP DocBlocks.

* [ ] Add unit tests.

* [ ] Add more functionalities.

## License

MIT © [guastallaigor](https://github.com/guastallaigor)