Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/victortavaresd3v/travel-agency-laravel-api

Travel Agency REST API
https://github.com/victortavaresd3v/travel-agency-laravel-api

api-documentation api-rest authentication continuous-integration docker laravel mysql php phpunit tests travel-agency-system

Last synced: 6 days ago
JSON representation

Travel Agency REST API

Awesome Lists containing this project

README

        

Travel Agency REST API

A Travel Agency application built with Laravel.










Key Features
How To Use
Technologies
License


travel agency

## Key Features

- CRUD Operations
- CREATE, READ, UPDATE and DELETE resources
- Authentication with Sanctum
- Admin & Editor functionalities
- Feature tests with PHPUnit
- Factory & Seeders
- Data validation
- Error Handling
- 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/travel-agency-laravel-api.git

# Go into the repository
$ cd travel-agency-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

---