Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/druxt/quickstart-druxt-site-tome
Databaseless Druxt starterkit template
https://github.com/druxt/quickstart-druxt-site-tome
quickstart
Last synced: 30 days ago
JSON representation
Databaseless Druxt starterkit template
- Host: GitHub
- URL: https://github.com/druxt/quickstart-druxt-site-tome
- Owner: druxt
- License: mit
- Created: 2022-02-08T04:32:26.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-06T23:00:11.000Z (about 1 month ago)
- Last Synced: 2024-11-07T00:18:55.721Z (about 1 month ago)
- Topics: quickstart
- Language: PHP
- Homepage:
- Size: 4.49 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- drupal-js - DruxtSite w/tome sync
README
# DruxtSite quickstart - Drupal with Tome sync
[](https://dl.circleci.com/status-badge/redirect/gh/druxt/quickstart-druxt-site-tome/tree/develop)
> One click, Fully Decoupled Drupal Site starter-kit with Druxt.
DruxtSite connects Drupal to Nuxt via JSON:API to provide a framework for building a Fully Decoupled site.
This repostory provides a quickstart installation of:
- Drupal 9 with Tome sync
- Nuxt 2
- DruxtSite
- DruxtAuth
- Node v16
## Quickstart
Try it before you fork it:
[](https://gitpod.io/#https://github.com/druxt/quickstart-druxt-site-tome)
## Getting started
### Local development (ddev)
1. Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.
2. Clone the repository locally.
Example: `git clone [email protected]:druxt/quickstart-druxt-site-tome.git`
3. Setup an `.env` file and update as required: `cp .env.example .env`
4. Install and setup Drupal:
(from repository root)
```
cd drupal
ddev start
ddev drupal-install
ddev druxt-add-consumer
```
5. Install and run Nuxt:
(from repository root)
```
cd nuxt
nvm use
npm install
npm run dev
```
### Cloud development (Gitpod.io)
1. Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.
2. Once the repository has been generated, open it in Gitpod by appending `https://gitpod.io#` to the GitHub url.
Example: `https://gitpod.io#github.com/druxt/quickstart-druxt-site-tome`
_Note:_ If this is your first time using Gitpod, you can signup for a free plan with your Github account.
3. Wait for your codebase to build.
_Note:_ To speed up this step, enable Prebuilds by follow the instructions @ https://www.gitpod.io/docs/prebuilds#enable-prebuilt-workspaces
## How to use it
Your environment contains a pre-install, pre-configured and running instance of Drupal with Tome, and Nuxt with the DruxtSite module enabled.
You can access the services in your browser, via the **Remote Explorer** extension, or via the URL pattern: `https://[PORT]-[GITPOD_ID].[GITPOD_SERVER].gitpod.io`
## Services
| Port | Service |
| -- | -- |
| `3000` | Nuxt.js |
| `3003` | Storybook |
| `8080` | Drupal |
## Tools
### DDEV
> DDEV is an open source tool that makes it dead simple to get local PHP development environments up and running within minutes.
DDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including `ddev drush`.
These commands should be run from within the `/drupal` folder.
Refer to the documentation for more details: https://ddev.readthedocs.io
### @nuxtjs/auth-next
> Zero-boilerplate authentication support for Nuxt.js!
The @nuxtjs/auth-next module is installed and configured to connect to the Drupal Simple OAuth module by way of the DruxtAuth module:
```js
this.$auth.loginWith('drupal-authorization_code')
```
- More details on how to use the `$auth` service can be found at https://auth.nuxtjs.org/api/auth
### @nuxtjs/storybook
> Storybook integration with NuxtJS .
Druxt integrates with the Nuxt Storybook module to provide zero-configuration, auto-discovery stories with access to live data from your Drupal backend.
To start Storybook, navigate to the `nuxt` directory and run `npx nuxt storybook`.
### Tome sync
Tome sync is a static storage system for content, allowing you to keep your content up to date without the need of a database.
See the project page for more details: https://www.drupal.org/project/tome
## License
[MIT](https://github.com/druxt/druxt.js/blob/develop/LICENSE)