Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victortavaresd3v/quiz-dev-laravel-api
Quiz Dev REST API
https://github.com/victortavaresd3v/quiz-dev-laravel-api
api-documentation api-rest continuous-integration docker laravel mysql php phpunit quiz-application tests
Last synced: 6 days ago
JSON representation
Quiz Dev REST API
- Host: GitHub
- URL: https://github.com/victortavaresd3v/quiz-dev-laravel-api
- Owner: victortavaresd3v
- License: mit
- Created: 2023-11-07T23:35:27.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-11-07T23:51:53.000Z (12 months ago)
- Last Synced: 2024-10-10T11:43:41.680Z (27 days ago)
- Topics: api-documentation, api-rest, continuous-integration, docker, laravel, mysql, php, phpunit, quiz-application, tests
- Language: PHP
- Homepage:
- Size: 384 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quiz Application REST API
A Quiz application built with Laravel.
Key Features •
How To Use •
Technologies •
License
## Key Features
- CRUD Operations
- CREATE, READ, UPDATE and DELETE resources
- Authentication with Sanctum
- Authorization with Policies
- Factory & Seeders
- Data validation
- Error Handling
- Feature tests with PHPUnit
- API Documentation with Scribe
- Continuous Integration with Github Actions
- Dockerized application
## How To Use
To run this application, you'll need [Docker](https://www.docker.com) in your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/victortavaresd3v/quiz-dev-laravel-api.git
# Go into the repository
$ cd quiz-dev-laravel-api
# Create a .env file and update the database config
$ cp .env.example .env
# Run the docker containers
$ docker-compose up -d
# Access the container
$ docker-compose exec app bash
# Install project dependencies
$ composer install
# Generate the Laravel project key
$ php artisan key:generate
```
## Technologies
This software uses the following technologies:
- [PHP](https://www.php.net/)
- [Laravel](https://laravel.com/)
- [MySQL](https://www.mysql.com/)
- [Scribe](https://scribe.knuckles.wtf/laravel/)
- [PHPUnit](https://phpunit.de/)
- [Docker](https://www.docker.com/)
- [Pint](https://laravel.com/docs/10.x/pint/)
- [Larastan](https://github.com/nunomaduro/larastan/)
## License
MIT
---
