zeppaman/api-farm-skeleton

ApiFarm startup project. Create a procject with zeppaman/api-farm installed

dev-main 2021-03-18 17:49 UTC

Requires

• php: >=7.2.5
• ext-ctype: *
• ext-iconv: *
• composer/package-versions-deprecated: 1.11.99.1
• doctrine/annotations: ^1.0
• doctrine/doctrine-bundle: ^2.2
• doctrine/doctrine-migrations-bundle: ^3.0
• doctrine/orm: ^2.8
• phpdocumentor/reflection-docblock: ^5.2
• sensio/framework-extra-bundle: ^5.1
• symfony/asset: 5.2.*
• symfony/console: 5.2.*
• symfony/dotenv: 5.2.*
• symfony/expression-language: 5.2.*
• symfony/flex: ^1.3.1
• symfony/form: 5.2.*
• symfony/framework-bundle: 5.2.*
• symfony/http-client: 5.2.*
• symfony/intl: 5.2.*
• symfony/mailer: 5.2.*
• symfony/mime: 5.2.*
• symfony/monolog-bundle: ^3.1
• symfony/notifier: 5.2.*
• symfony/process: 5.2.*
• symfony/property-access: 5.2.*
• symfony/property-info: 5.2.*
• symfony/proxy-manager-bridge: 5.2.*
• symfony/security-bundle: 5.2.*
• symfony/serializer: 5.2.*
• symfony/string: 5.2.*
• symfony/translation: 5.2.*
• symfony/twig-bundle: ^5.2
• symfony/validator: 5.2.*
• symfony/web-link: 5.2.*
• symfony/yaml: 5.2.*
• twig/extra-bundle: ^2.12|^3.0
• twig/twig: ^2.12|^3.0
• zeppaman/api-farm: dev-main

Requires (Dev)

• symfony/browser-kit: ^5.2
• symfony/css-selector: ^5.2
• symfony/debug-bundle: ^5.2
• symfony/maker-bundle: ^1.0
• symfony/phpunit-bridge: ^5.2
• symfony/stopwatch: ^5.2
• symfony/var-dumper: ^5.2
• symfony/web-profiler-bundle: ^5.2

Conflicts

• symfony/symfony: *

GPL-3.0-or-later

README

This is the skeleton project for api farm. Go to the main project page for more info

Setup

# create a project
COMPOSER_MEMORY_LIMIT=-1 composer create-project zeppaman/api-farm-skeleton my-project --stability=dev

cd my-project

docker-compose up 

# configure the application
docker-compose exec app ./vendor/bin/apifarm-install apifarm:config [--db-host DB-HOST] [--db-port DB-PORT] [--db-password DB-PASSWORD] [--db-user DB-USER]

# install the database
docker-compose exec app  bin/console apifarm:install [--adminuser ADMINUSER] [--adminpassword ADMINPASSWORD] [--db-host DB-HOST] [--db-port DB-PORT] [--db-password DB-PASSWORD] [--db-user DB-USER]

Command setup

# bin/console apifarm:install --help
Usage:
  apifarm:install [options]

Options:
      --adminuser=ADMINUSER          username for initial administator [default: "admin"]
      --adminpassword=ADMINPASSWORD  password for initial administator [default: "admin"]   
  -h, --help                         Display help for the given command. When no command is given display help for the list command
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi                         Force ANSI output
      --no-ansi                      Disable ANSI output
  -n, --no-interaction               Do not ask any interactive question
  -e, --env=ENV                      The Environment name. [default: "dev"]
      --no-debug                     Switch off debug mode.
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug