kadirov/api-starter-kit

v1.5.3 2023-12-11 16:28 UTC

Requires

• php: 8.2.*
• ext-ctype: *
• ext-iconv: *
• api-platform/core: 3.1.*
• doctrine/annotations: 2.0.*
• doctrine/doctrine-bundle: 2.8.*
• doctrine/doctrine-migrations-bundle: 3.2.*
• doctrine/orm: 2.14.*
• lexik/jwt-authentication-bundle: 2.18.*
• nelmio/cors-bundle: 2.2.*
• phpdocumentor/reflection-docblock: 5.3.*
• phpstan/phpdoc-parser: 1.16.*
• symfony/asset: 6.2.*
• symfony/console: 6.2.*
• symfony/dotenv: 6.2.*
• symfony/expression-language: 6.2.*
• symfony/flex: 2.2.*
• symfony/framework-bundle: 6.2.*
• symfony/property-access: 6.2.*
• symfony/property-info: 6.2.*
• symfony/proxy-manager-bridge: 6.2.*
• symfony/runtime: 6.2.*
• symfony/security-bundle: 6.2.*
• symfony/serializer: 6.2.*
• symfony/twig-bundle: 6.2.*
• symfony/validator: 6.2.*
• symfony/yaml: 6.2.*

Requires (Dev)

• symfony/maker-bundle: 1.48.*

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *

GPL-3.0-or-later

README

Starter kit for API with Symfony, Doctrine, Maker Bundle, Migrations Bundle, Api-Platform and JWT-auth.

Kit has also already created User entity with all crud routes

Kit has 3 docker containers: php, nginx and mysql

Installation

Download the project
composer create-project kadirov/api-starter-kit --ignore-platform-reqs --no-scripts

Go to the project directory
cd api-starter-kit

Run docker containers
docker compose up -d

Install composer scripts:
docker compose exec php composer install

To install project run command:
docker compose exec php bin/console ask:install

Done! You can open http://localhost:8507/api via browser. By the way, you can change this port by changing DOCKER_NGINX_PORT variable in .env file.

Docker

For enter to php container run docker compose exec php bash

For enter to mysql container run docker compose exec mysql bash

For enter to nginx container run docker compose exec nginx bash

You can change containers prefix by changing DOCKER_PROJECT_NAME variable in .env file.

Also, you can change public ports of nginx and mysql by changing DOCKER_NGINX_PORT and DOCKER_DATABASE_PORT

Database allows connections only from localhost. Because of this when you use the project on production and want to connect to database from your computer you should connect via ssh bridge.

Cron

You can use docker/php/cron-file for cron jobs. After you must re-build php container by running command:
docker compose up -d --build

Swagger

You can change project name and description on swagger by editing file config/packages/api_platform.yaml

Git Hook

If you don't use any deploying system you can do
cp docker/other-files/git/hooks/post-merge .git/hooks

In this way git always executes command bin/console ask:deploy. You can change this command in the file src/Command/AskDeployCommand.php. This command will install requirements via composer, clear caches, change owner of ./var and ./public/media folders to www-data, will run migrations.

JWT keys

For use Json Web Token system you must create private and public keys. They are have already created when you install project. You can re-create them with:

bin/console ask:generate:jwtKeys