https://github.com/runroom/archetype-symfony

This is our Symfony project template
https://github.com/runroom/archetype-symfony

docker javascript php symfony template twig

Last synced: 4 days ago
JSON representation

This is our Symfony project template

• Host: GitHub
• URL: https://github.com/runroom/archetype-symfony
• Owner: Runroom
• License: mit
• Created: 2020-02-11T08:43:20.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T19:54:33.000Z (9 days ago)
• Last Synced: 2024-11-06T20:29:45.938Z (9 days ago)
• Topics: docker, javascript, php, symfony, template, twig
• Language: PHP
• Homepage: https://www.runroom.com
• Size: 23.8 MB
• Stars: 17
• Watchers: 11
• Forks: 12
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Archetype Symfony

[![CI](https://github.com/Runroom/archetype-symfony/actions/workflows/ci.yaml/badge.svg)](https://github.com/Runroom/archetype-symfony/actions/workflows/ci.yaml)

[![QA](https://github.com/Runroom/archetype-symfony/actions/workflows/qa.yaml/badge.svg)](https://github.com/Runroom/archetype-symfony/actions/workflows/qa.yaml)

[![Build](https://github.com/Runroom/archetype-symfony/actions/workflows/build.yaml/badge.svg)](https://github.com/Runroom/archetype-symfony/actions/workflows/build.yaml)

## Requirements

To run this project, you need to have:

- [Git](https://git-scm.com/)

- [Nvm](https://github.com/nvm-sh/nvm)

- [NPM](https://www.npmjs.com/)

- [Mkcert](https://github.com/FiloSottile/mkcert)

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/compose/)

## Setup

To start the project for the first time:

```bash

    make

```

To generate build assets:

```bash

    nvm use

    npm clean-install

    npx encore dev

```

- Open `https://localhost:8443` in your browser.

- Open `https://localhost:8425` in your browser to access Mailpit.

To use xDebug, after the initial `make`, you can run:

```bash

    make up-debug

```

And you will only restart the `app` container with the xDebug enabled, to disable it again, run

`make up` again.

To run the application in production mode:

```bash

    make prod

```

Remember to run `make dev` when you finish working on the project in prod mode.

## Contribute

Please refer to [CONTRIBUTING](doc/Contributing.md) for information on how to contribute to the

Archetype and its related projects.

## Additional documentation

- [Code of conduct](doc/Code_of_conduct.md)

- [Continuous Integration](doc/Continuous_integration.md)

- [Contributing](doc/Contributing.md)

- [Cookies](doc/Cookies.md)

- [Deployment](doc/Deployment.md)

- [Docker](doc/Docker.md)

- [Mailpit](doc/Mailpit.md)

- [Migrations](doc/Migrations.md)

- [Frontend Architecture](doc/frontend/architecture/Index.md)