https://github.com/runroom/archetype-drupal
This is our Drupal project template
https://github.com/runroom/archetype-drupal
docker drupal javascript php template twig
Last synced: 11 months ago
JSON representation
This is our Drupal project template
- Host: GitHub
- URL: https://github.com/runroom/archetype-drupal
- Owner: Runroom
- License: mit
- Created: 2020-03-17T10:06:10.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T18:45:00.000Z (11 months ago)
- Last Synced: 2025-04-19T02:50:09.390Z (11 months ago)
- Topics: docker, drupal, javascript, php, template, twig
- Language: PHP
- Homepage: https://www.runroom.com
- Size: 17.8 MB
- Stars: 6
- Watchers: 6
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Archetype Drupal
[](https://github.com/Runroom/archetype-drupal/actions/workflows/ci.yaml)
[](https://github.com/Runroom/archetype-drupal/actions/workflows/qa.yaml)
[](https://github.com/Runroom/archetype-drupal/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/cli-command/)
## 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 log in to the user panel for the first time:
```bash
make ssh
drush user:login --uri=https://localhost:8443
```
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)
- [Deployment](doc/Deployment.md)
- [Docker](doc/Docker.md)
- [Drupal](doc/Drupal.md)
- [Mailpit](doc/Mailpit.md)