drupal-tome / tome-project
A starter project for Tome.
Installs: 1 515
Dependents: 0
Suggesters: 0
Security: 0
Stars: 69
Watchers: 6
Forks: 7
Open Issues: 7
Type:project
Requires
- composer/installers: ^1.9
- cweagans/composer-patches: ^1.7
- drupal-tome/tome_drush: dev-master
- drupal/core: ^10
- drupal/core-composer-scaffold: ^10
- drupal/tome: ^1
- drush/drush: ^12
- webflo/drupal-finder: ^1.2
This package is auto-updated.
Last update: 2024-11-03 23:13:47 UTC
README
This project is a great place to start for building brand new Tome projects.
There isn't much here now, but keep posted and let me know if anything doesn't work!
Requirements
You can also run Tome inside a Docker container - see the Docker documentation below for reference.
Usage
To create a new Tome project, run:
composer create-project drupal-tome/tome-project my_site --stability dev --no-interaction drush tome:init
To re-install Tome, run:
drush tome:install
To start a local webserver, run:
drush runserver
When you're ready to build your static site, run:
drush tome:static
Symlinks
When composer install or update is ran, the "modules" and "themes" directories, as well as the "settings.php" file, is symlinked into the "web" directory.
This is done to improve DX, but only works on systems that support bash
, and
symlinks. If you're running Windows you'll probably want to write a custom
script to replace symlink.sh
, and use the mklink
command. Pull requests are
welcome to make this functionality cross-platform by default.
Docker
A Docker image for Tome is available on Docker Hub as mortenson/tome
.
You can use the image instead of local versions of Drush and Composer by using these included scripts:
./scripts/ddrush.sh
- Runs Drush in the current directory../scripts/drunserver.sh
- Runsdrush runserver
and maps port 8888../scripts/dexec.sh
- Runs a shell command, use./scripts/dexec.sh bash
to open an interactive session.
More instructions on how to use the image can be found at drupal-tome/tome-docker.
Included Netlify, GitPod, and GitHub Pages configuration
For ease of use, netlify.toml
and .gitpod.yml
files have been included so
that you can start using these services as soon as you create a project.
Netlify provides free static site hosting and supports Tome, and Gitpod allows
you to edit Drupal content, config, and code without running a local site. For
more information, visit https://netlify.com/ and https://gitpod.io/.
For GitHub Pages, you'll need to copy .example_github to .github and enable
GitHub actions. Then, on commit to master
, a static site should be exported
to the gh-pages
branch. You can configure what branch to use for GitHub pages
in the repository settings.
Further reading
This project is largely based on drupal-composer/drupal-project, so it's recommended that you consult their README.md for more information.