https://github.com/adnane-ka/dev-suite
a suit of basic files samples to build a light-weight , short-handed & a strong Laravel REST API Applications.
https://github.com/adnane-ka/dev-suite
Last synced: 2 months ago
JSON representation
a suit of basic files samples to build a light-weight , short-handed & a strong Laravel REST API Applications.
- Host: GitHub
- URL: https://github.com/adnane-ka/dev-suite
- Owner: adnane-ka
- Created: 2021-11-22T12:22:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-22T15:20:09.000Z (about 4 years ago)
- Last Synced: 2025-01-25T23:01:05.534Z (11 months ago)
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Concerning Laravel. I found myself repeating a very basic form of code each time i begin a new REST API. in which the whole Interface's pieces are developed from a sample of each piece. eg:each one of the Models, Controllers, Routes, Test suits, Requests and so on follow a certain manner of writing code.
in this repository i've collected these files samples, so i can get rid of repeating them each time in each project. and since i love to share code with others, i decided to share that repository with you! i hope you can find it useful.
## Available sample files
- [A Model file](app/Models/Sample.php)
- [A Controller file (Note that this class extends the base controller for the API)](app/Http/Controllers/Api/SampleController.php)
- [A Base Base Controller file](app/Http/Controllers/ApiController.php)
- [A Request file (Note that this class extends the base form request)](app/Http/Requests/SampleRequest.php)
- [A Base Form Request file](app/Http/Requests/CustomFormRequest.php)
- [API v1 Routes(Routes are loaded from the RouteServiceProvider class)](routes/api/v1.php)
- [A Feature Test File](tests/Feature/SampleTest.php)
## Requirements
Basically, you'll need -besides Laravel 8.x requirements- to activate pdo_sqlite extension in your php configuration file if you're running your application in windows OS and install it if you're doing that in linux OS.
## Installation
1. As any other github repo, download or clone the repository
```
git clone https://github.com/adnane-ka/dev-suite.git
```
2. Install the app's dependencies
```
composer install
```
3. Create a database and run laravel migrations
```
php artisan migrate
```
## Initialization
Since everything is based on use cases, i love to let tests run and control the application. so to make sure that everything works well just run phpunit.
```
vendor/bin/phpunit
```