monogramm/vue-symfony-starter repository overview

⁠Vue Symfony Starter

:construction: This project is still in beta!

⁠:blue_book: Docs

See GitHub Pages at monogramm.github.io/vue-symfony-starter⁠.

You can generate the PHP documentation using PHPDocumentor:

docker run --rm -v "${PWD}:/data" phpdoc/phpdoc:3 run

⁠:chart_with_upwards_trend: Changes

All notable changes to this project will be documented in CHANGELOG⁠ file.

This CHANGELOG is generated with :heart: by gitmoji-changelog⁠.

This project adheres to Semantic Versioning⁠.

⁠:bookmark: Roadmap

See Taiga.io⁠

⁠:whale: Supported Docker tags

Dockerhub monogramm/vue-symfony-starter⁠

• latest
• debian
• develop
• gitpod

⁠Docker Development environment

You can build and run a development environment using Docker (recommended).

⁠:construction: Docker Development Install

./manage.sh dev:build

⁠:rocket: Docker Development Usage

./manage.sh dev:start

Now go to http://localhost:8000⁠ to access development environment using docker. Go to http://localhost:6006⁠ to access the storybook.

⁠Docker Production environment

You can build and run a "production-like" environment using Docker.

⁠:construction: Docker Production Install

./manage.sh prod:build

⁠:rocket: Docker Production Usage

./manage.sh prod:start

Now go to http://localhost:8080⁠ to access development environment using docker.

⁠Local Development environment

You can run the development environment locally.

You can also use GitPod⁠ to run the local development environment:

If you wish to sign your commits using GitPod, follow the instructions from gitpod-io/gitpod#666⁠:

• Convert your source .gnugpg directory contents to base64 data: tar -czvf - ./.gnupg | base64 -w 0
• Place this data into a gitpod environment variable called GNUGPG
• Get your source signing key: gpg --list-secret-keys --keyid-format LONG
• Place this data into a gitpod environment variable called GNUGPG_KEY

⁠:construction: Local Development Install

Requires PHP 7.4 or higher, Composer 2⁠, Symfony 4.4⁠ and yarn⁠ installed. You can check your local requirements with the following command:

./manage.sh local:check

To install locally:

./manage.sh local:build

⁠:rocket: Local Development Usage

To start frontend and backend:

./manage.sh local:start

Now go to http://localhost:8000⁠ to access development environment using your local host. Make sure the create an admin using the command line for full access to the application:

./manage.sh local:console app:users:create --role=ADMIN --verified admin [email protected] password

To start local storybook:

./manage.sh local:start-back

Now go to http://localhost:6006⁠ to access locally the storybook.

⁠:white_check_mark: Run tests

All tests are executed automatically when building the Docker production images, but it is possible to execute tests locally.

Code coverage results will be stored in ./coverage directory at the end of CI builds.

⁠Backend tests and code quality analysis

./manage.sh local:test-back

⁠Frontend tests and code quality analysis

./manage.sh local:test-front

⁠:construction_worker: Continuous Integration

This project support Continuous Integration with the following platforms:

• DockerHub Advanced Automated Build⁠ hooks
• GitHub Actions⁠ using DockerHub Advanced Automated Build hooks
• Travis-CI⁠ using DockerHub Advanced Automated Build hooks
• Codacy⁠ code quality and code coverage review
• Snyk⁠ security review

⁠:bust_in_silhouette: Authors

Monogramm

• Website: https://www.monogramm.io⁠
• Github: @Monogramm⁠

Mathieu BRUNOT

• GitHub: @madmath03⁠

Artur Khachaturyan

• Github: @Arky9782⁠

⁠:handshake: Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page⁠. Check the contributing guide⁠.

⁠:thumbsup: Show your support

Give a :star: if this project helped you!

⁠:page_facing_up: License

Copyright © 2021 Monogramm⁠.
This project is AGPL v3⁠ licensed.

This README was generated with :heart: by readme-md-generator⁠