- Introduction
- Technologies Used
- Features
- Setup and Installation
- Testing
- Static Analysis
- CI/CD Pipeline
The Logistic Price Calculation API is a RESTful service that calculates transport prices based on route details provided in the request. The API uses the Google Directions API to determine the total distance between multiple addresses and calculates the price for different vehicle types based on this distance.
- Docker compose
- PHP 8.2
- Lumen Framework
- MongoDB
- cURL for HTTP requests
- Google Directions API
- PHPUnit for testing
- Redis for caching
- PHPStan for static analysis
- GitHub Actions for CI/CD
- Transport Price Calculation: Calculate prices for different vehicle types based on the total distance between multiple addresses.
- Basic Authentication: Secures the API with Basic Authentication using an API key.
- Input Validation: Validates the input to ensure addresses exist in the database.
- Error Handling: Provides detailed error messages for invalid requests or API errors.
- Clone the repository
- docker-compose up --build
- docker exec -it logistics_app ./vendor/bin/phpunit
- docker exec -it logistics_app ./vendor/bin/phpstan analyze app
- The GitHub Actions workflow is defined in the .github/workflows
- Triggering Events: The pipeline runs on push and pull_request events targeting the main branch. Composer Validation: Ensures that the Composer configuration is valid. Dependency Management: Efficiently handles dependencies using caching and installation steps. Static Analysis and Testing: Ensures code quality through PHPStan and PHPUnit.
You can find Postman collection in root directory