View Docs · Report Bug · Request Feature
Pandora is a modern, customized, feature-rich API starter kit to kickstart your next REST API backend.
- API Documentation
- Dockerized
- OpenAPI Specification
- Service Repository Pattern
- Testing
- API Resource
- Code Style & Lint
- CI/CD
- Log Viewer
Complete documentation for Pandora can be found here.
The API documentation:
Prerequisite
- PHP 8.2
To setup Pandora, first clone the project and change the directory.
git clone https://github.com/arifszn/pandora.git
cd pandora
Then follow the process using either Docker or Without Docker and you will have a fully running Laravel installation with Sanctum, all configured.
Laravel Sail is a light-weight command-line interface for interacting with Laravel's default Docker development environment.
-
Copy
.env.example
to.env
:cp .env.example .env
-
Install the dependencies:
docker run --rm \ -u "$(id -u):$(id -g)" \ -v $(pwd):/var/www/html \ -w /var/www/html \ laravelsail/php82-composer:latest \ composer install --ignore-platform-reqs
-
Run the containers:
./vendor/bin/sail up -d
-
Generate application key:
./vendor/bin/sail artisan key:generate
-
Run database migration with seeder:
./vendor/bin/sail artisan migrate --seed
To learn more about Sail, visit the official Doc.
-
Copy
.env.example
to.env
:cp .env.example .env
-
Install the dependencies:
composer install
-
Generate application key:
php artisan key:generate
-
Run database migration with seeder:
php artisan migrate --seed
-
Start the local server:
php artisan serve
You can show your support by starring this project.
To contribute, see the contributing guide.
This starter kit is inspired by the project Hydra.