Skip to content
REST API with Symfony Flex
PHP Other
  1. PHP 99.0%
  2. Other 1.0%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea IDE settings. Aug 14, 2019
.phan feat: Added phan/phan analyzer May 28, 2018
bin refactor: small clean up Apr 28, 2019
config env: Enabled APC/APCu Jul 29, 2019
doc doc: Updated make commands. Aug 3, 2019
docker env: Cleanup for Xdebug configuration on dev environment. Jul 29, 2019
public feat: Updated `check.php` and added support that users can access to … Jun 1, 2019
secrets Refactor: First phase of test run refactor job - This one is going to… Feb 25, 2019
src fix: corrected use statements order. Aug 16, 2019
templates refactor: removed maker command. Jul 13, 2019
tests tests: Refactored BodySubscriberTest to use `RequestEvent` instead of… Aug 7, 2019
tools chore(deps): Updated dependencies. Aug 16, 2019
translations ... Aug 24, 2017
.codeclimate.yml tests: Changed CodeClimate configuration. Jun 23, 2019
.dockerignore refactor: Updated ignore files. Jul 15, 2019
.editorconfig tests: Changed `editorconfig` settings. Jul 7, 2019
.env typo fix Jan 31, 2019
.env.test Refactor: First phase of test run refactor job - This one is going to… Feb 25, 2019
.env.travis fix: TravisCI Jan 31, 2019
.gitattributes composer.lock and symfony.lock files to binary diff Apr 23, 2018
.gitignore refactor: Updated ignore files. Jul 15, 2019
.php_cs.dist feat: Added symplify/easy-coding-standard Feb 15, 2018
.sensiolabs.yml fix: sensiolabs analysis Jan 31, 2019
.travis.yml tests: Changed TravisCI configuration. Jul 6, 2019
Dockerfile env: Updated composer docker image. Aug 17, 2019
Dockerfile_dev env: Updated composer docker image. Aug 17, 2019
LICENSE Added README and LICENSE May 5, 2017
Makefile env: Ensure that build directory exists. Aug 13, 2019
README.md docs: Small fix Jun 16, 2019
bootstrap.php refactor: Fixed deprecation warning within tests. Jul 4, 2019
composer.json chore(deps): Updated dependencies. Aug 11, 2019
composer.lock chore(deps): Updated dependencies. Aug 13, 2019
docker-compose.yml feat: Added support for CLI commands debug. May 22, 2019
docker-entrypoint-dev.sh env: Cleanup for Xdebug configuration on dev environment. Jul 29, 2019
docker-entrypoint.sh env: Changed dev docker file and added proper one for production build. Jul 16, 2019
docker-sync.yml refactor: improve docker-sync speed May 17, 2019
easy-coding-standard.yaml tests: ECS rules May 31, 2019
infection.json.dist tests: Added Infection library - https://infection.github.io/ Sep 2, 2018
merge-phpunit-xml.php fix: declare stuff May 17, 2019
phpinsights.php refactor: Updated static analysis tools configuration. Jul 15, 2019
phpmd_ruleset.xml tests: Added custom PHP Mess Detector rules and enabled it with Code … Dec 13, 2017
phpstan.neon.dist env: Changed PHPStan configuration. Jul 11, 2019
phpunit.fastest.xml refactor: Changed PHPUnit configuration. Jul 4, 2019
phpunit.xml.dist refactor: Changed PHPUnit configuration. Jul 4, 2019
psalm.xml refactor: Updated static analysis tools configuration. Jul 15, 2019
sonar-project.properties tests: Changed SonarCloud configuration. Jun 23, 2019
symfony.lock feat: Add `mark-gerarts/automapper-plus-bundle`, this will be used wi… Jun 21, 2019

README.md

What is this

MIT licensed Build Status Coverage Status Psalm coverage Scrutinizer Code Quality Maintainability Sonarcloud Quality Gate Sonarcloud Vulnerabilities Sonarcloud Vulnerabilities Sonarcloud Vulnerabilities SymfonyInsight

JSON REST API which is build on top of Symfony framework.

Note that this project is build with Symfony 4 and Symfony Flex.

Table of Contents

Requirements

Installation

This installation guide expects that you're using docker-compose.

1. Clone repository

Use your favorite IDE and get checkout from GitHub or just use following command

git clone https://github.com/tarlepp/symfony-flex-backend.git

2. Start containers

For this just run following command:

docker-compose up

This command will create three (3) containers to run this backend application. Those containers are following:

  • php (this is for actual application)
  • nginx (this will serve application)
  • mysql (MySQL 5.7 which will store all the data of application)

3. Using application

By default docker-compose up command starts those three containers and exposes following ports on localhost:

  • 8000 (nginx + php-fpm)
  • 3310 (mysql)

And this application is usable within your browser on http://localhost:8000 address.

MySQL credentials:

user: root
password: password

4. Getting shell to container

After you've run docker-compose up command you can list all running containers with docker ps command.

And to eg. get shell access inside one of those containers you can run following command:

docker-compose exec php bash

Where that php is that actual container where this backend application is running.

5. Building containers

For time to time you probably need to build containers again. This is something that you should do everytime if you have some problems to get containers up and running. This you can do with following command:

docker-compose up --build 

Resources

External links / resources

Authors

License

The MIT License (MIT)

Copyright © 2019 Tarmo Leppänen

You can’t perform that action at this time.