{"id":13653107,"url":"https://github.com/druxt/quickstart","last_synced_at":"2025-05-02T09:30:36.769Z","repository":{"id":39115168,"uuid":"398425279","full_name":"druxt/quickstart","owner":"druxt","description":"One click, fully Decoupled Drupal with DruxtJS.","archived":false,"fork":false,"pushed_at":"2025-04-17T16:39:48.000Z","size":3990,"stargazers_count":13,"open_issues_count":17,"forks_count":10,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-04-18T07:01:54.623Z","etag":null,"topics":["drupal","druxt","gitpod","nuxt","template"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/druxt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-08-20T23:50:47.000Z","updated_at":"2023-05-03T09:13:28.000Z","dependencies_parsed_at":"2023-12-29T03:25:57.701Z","dependency_job_id":"42c5a96d-de9b-444e-a0b6-5e33797ba2cf","html_url":"https://github.com/druxt/quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druxt%2Fquickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druxt%2Fquickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druxt%2Fquickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druxt%2Fquickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/druxt","download_url":"https://codeload.github.com/druxt/quickstart/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251516944,"owners_count":21601910,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["drupal","druxt","gitpod","nuxt","template"],"created_at":"2024-08-02T02:01:05.925Z","updated_at":"2025-05-02T09:30:35.524Z","avatar_url":"https://github.com/druxt.png","language":"PHP","funding_links":[],"categories":["Framework: Nuxt.js"],"sub_categories":["Druxt Quick-start templates"],"readme":"# Druxt Quickstart\n\n\u003e One click, fully Decoupled Drupal with DruxtJS.\n\nDruxt Quickstart provides a Drupal and Nuxt mono-repo to get you started with DruxtJS power decoupled Drupal development.\n\nThis repostory provides a quickstart installation of:\n- Drupal 9\n- Nuxt 2\n- Druxt 0\n\n## Quick-er-start\n\nTry it before you fork it:\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/druxt/quickstart)\n\n\n## Theme branches\n\nStart quicker with a pre-installed UI Framework.\n\n- [BootstrapVue](https://github.com/druxt/quickstart/tree/theme/bootstrap-vue)\n- [TailwindCSS](https://github.com/druxt/quickstart/tree/theme/tailwindcss)\n\n\n## Getting started\n\n### Local development with [DDev](https://ddev.readthedocs.io)\n\n1. Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.\n\n2. Clone the repository locally.\n\n   Example: `git clone git@github.com:druxt/quickstart.git`\n\n3. Setup an `.env` file and update as required: `cp .env.example .env`\n\n4. Install and setup Drupal:\n\n   (from repository root)\n\n   ```\n   cd drupal\n   ddev start\n   ddev drupal-install\n   ddev druxt-add-consumer\n   ```\n\n5. Install and run Nuxt:\n\n   (from repository root)\n\n   ```\n   cd nuxt\n   nvm use\n   npm install\n   npm run dev\n   ```\n\n\n### Cloud development with [Gitpod.io](https://gitpod.io)\n\n1. Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.\n\n2. Once the repository has been generated, open it in Gitpod by appending `https://gitpod.io#` to the GitHub url.\n\n   Example: `https://gitpod.io#github.com/druxt/quickstart`\n\n   _Note:_ If this is your first time using Gitpod, you can signup for a free plan with your Github account.\n\n3. Wait for your codebase to build.\n\n   _Note:_ To speed up this step, enable Prebuilds by follow the instructions @ https://www.gitpod.io/docs/prebuilds#enable-prebuilt-workspaces\n\n\n## How to use it\n\nYour environment contains a pre-install, pre-configured and running instance of Drupal and Nuxt, with the DruxtSite module enabled.\n\nYou 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`\n\n\n## Services\n\n| Port | Service |\n| -- | -- |\n| `3000` | Nuxt.js |\n| `3003` | Storybook |\n| `8080` | Drupal |\n\n\n## Tools\n\n### DDEV\n\n\u003e DDEV is an open source tool that makes it dead simple to get local PHP development environments up and running within minutes. \n\nDDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including `ddev drush`.\n\nThese commands should be run from within the `/drupal` folder.\n\nRefer to the documentation for more details: https://ddev.readthedocs.io\n\n### @nuxtjs/auth-next\n\n\u003e Zero-boilerplate authentication support for Nuxt.js!\n\nThe @nuxtjs/auth-next module is installed and configured to connect to the Drupal Simple OAuth module by way of the DruxtAuth module:\n\n```js\nthis.$auth.loginWith('drupal-authorization_code')\n```\n\n- More details on how to use the `$auth` service can be found at https://auth.nuxtjs.org/api/auth\n\n### @nuxtjs/storybook\n\n\u003e Storybook integration with NuxtJS .\n\nDruxt integrates with the Nuxt Storybook module to provide zero-configuration, auto-discovery stories with access to live data from your Drupal backend.\n\nTo start Storybook, navigate to the `nuxt` directory and run `npx nuxt storybook`.\n\n\n## License\n\n[MIT](https://github.com/druxt/druxt.js/blob/develop/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdruxt%2Fquickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdruxt%2Fquickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdruxt%2Fquickstart/lists"}