Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monogramm/vue-symfony-starter
:elephant: A "simple" starter project using Vue.js and Symfony.
https://github.com/monogramm/vue-symfony-starter
docker php starter-kit symfony vuejs
Last synced: about 6 hours ago
JSON representation
:elephant: A "simple" starter project using Vue.js and Symfony.
- Host: GitHub
- URL: https://github.com/monogramm/vue-symfony-starter
- Owner: Monogramm
- License: agpl-3.0
- Created: 2021-02-01T16:11:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T22:25:20.000Z (about 1 month ago)
- Last Synced: 2024-10-18T22:37:40.206Z (28 days ago)
- Topics: docker, php, starter-kit, symfony, vuejs
- Language: PHP
- Homepage: https://monogramm.github.io/vue-symfony-starter/
- Size: 3.2 MB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![License: AGPL v3][uri_license_image]][uri_license]
[](https://monogramm.github.io/vue-symfony-starter/)
[](https://github.com/frinyvonnick/gitmoji-changelog)
[](https://tree.taiga.io/project/monogrammbot-monogrammvue-symfony-starter/ "Managed with Taiga.io")
[](https://github.com/Monogramm/vue-symfony-starter)
[](https://gitpod.io/#https://github.com/Monogramm/vue-symfony-starter)
[](https://www.codacy.com/gh/Monogramm/vue-symfony-starter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Monogramm/vue-symfony-starter&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/Monogramm/vue-symfony-starter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Monogramm/vue-symfony-starter&utm_campaign=Badge_Coverage)
[](https://github.com/Monogramm/vue-symfony-starter/actions)
[](https://hub.docker.com/r/monogramm/vue-symfony-starter/)
[](https://hub.docker.com/r/monogramm/vue-symfony-starter/)
# **Vue Symfony Starter**
> :alembic: A 'simple' starter project using Vue.js and Symfony.
:construction: **This project is still in beta!**
## :blue_book: Docs
See GitHub Pages at [monogramm.github.io/vue-symfony-starter](https://monogramm.github.io/vue-symfony-starter/).
You can generate the PHP documentation using PHPDocumentor:
```bash
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](./CHANGELOG.md) file.
This CHANGELOG is generated with :heart: by [gitmoji-changelog](https://github.com/frinyvonnick/gitmoji-changelog).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## :bookmark: Roadmap
See [Taiga.io](https://tree.taiga.io/project/monogrammbot-monogrammvue-symfony-starter/ "Taiga.io monogrammbot-monogrammvue-symfony-starter")
## :whale: Supported Docker tags
[Dockerhub monogramm/vue-symfony-starter](https://hub.docker.com/r/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
```bash
./manage.sh dev:build
```
### :rocket: Docker Development Usage
```bash
./manage.sh dev:start
```
Now go to to access development environment using docker.
Go to to access the storybook.
## Docker Production environment
You can build and run a "_production-like_" environment using Docker.
### :construction: Docker Production Install
```bash
./manage.sh prod:build
```
### :rocket: Docker Production Usage
```bash
./manage.sh prod:start
```
Now go to to access development environment using docker.
## Local Development environment
You can run the development environment locally.
You can also use [GitPod](https://gitpod.io/) to run the local development environment: [](https://gitpod.io/#https://github.com/Monogramm/vue-symfony-starter)
If you wish to sign your commits using GitPod, follow the instructions from [gitpod-io/gitpod#666](https://github.com/gitpod-io/gitpod/issues/666#issuecomment-534347856):
- 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](https://getcomposer.org/), [Symfony 4.4](https://symfony.com/) and [yarn](https://yarnpkg.com/) installed.
You can check your local requirements with the following command:
```bash
./manage.sh local:check
```
To install locally:
```bash
./manage.sh local:build
```
### :rocket: Local Development Usage
To start frontend and backend:
```sh
./manage.sh local:start
```
Now go to to access development environment using your local host.
Make sure the create an admin using the command line for full access to the application:
```bash
./manage.sh local:console app:users:create --role=ADMIN --verified admin [email protected] password
```
To start local storybook:
```sh
./manage.sh local:start-back
```
Now go to 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
```bash
./manage.sh local:test-back
```
### Frontend tests and code quality analysis
```bash
./manage.sh local:test-front
```
## :construction_worker: Continuous Integration
This project support Continuous Integration with the following platforms:
- DockerHub [Advanced Automated Build](https://docs.docker.com/docker-hub/builds/advanced/) hooks
- [GitHub Actions](https://docs.github.com/en/actions) using DockerHub Advanced Automated Build hooks
- [Travis-CI](https://travis-ci.com/) using DockerHub Advanced Automated Build hooks
- [Codacy](https://www.codacy.com/) code quality and code coverage review
- [Snyk](https://snyk.io/) security review
## :bust_in_silhouette: Authors
**Monogramm**
- Website:
- Github: [@Monogramm](https://github.com/Monogramm)
**Mathieu BRUNOT**
- GitHub: [@madmath03](https://github.com/madmath03)
**Artur Khachaturyan**
- Github: [@Arky9782](https://github.com/orgs/Monogramm/people/Arky9782)
## :handshake: Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Monogramm/vue-symfony-starter/issues).
[Check the contributing guide](./CONTRIBUTING.md).
## :thumbsup: Show your support
Give a :star: if this project helped you!
## :page_facing_up: License
Copyright © 2021 [Monogramm](https://github.com/Monogramm).
This project is [AGPL v3](uri_license) licensed.
* * *
_This README was generated with :heart: by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
[uri_license]: http://www.gnu.org/licenses/agpl.html
[uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg