Skip to content

Commit 4c99b3f

Browse files
authored
docs: LDP-1975: Add StackBlitz link and improve docs. (#105)
1 parent 62d65c2 commit 4c99b3f

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Please refer to https://stack.lupus.digital for more info.
2323
1. Add `nuxtjs-drupal-ce` dependency to your Nuxt project
2424

2525
```bash
26-
yarn add nuxtjs-drupal-ce # or npm install nuxtjs-drupal-ce
26+
yarn add nuxtjs-drupal-ce@alpha # or npm install nuxtjs-drupal-ce@alpha
2727
```
2828

2929
2. Add `nuxtjs-drupal-ce` to the `modules` section of `nuxt.config.js`
@@ -34,7 +34,7 @@ export default defineNuxtConfig({
3434
'nuxtjs-drupal-ce',
3535
],
3636
drupalCe: {
37-
baseURL: 'https://your-drupal.example.com',
37+
baseURL: 'https://your-drupal.example.com/ce-api',
3838
// more options...
3939
}
4040
})
@@ -88,10 +88,16 @@ export default defineNuxtConfig({
8888

8989
## Development
9090

91-
1. Clone this repository
92-
2. Install dependencies using `npm install`
93-
3. Use `npm run dev` to start [playground](./playground) in development mode.
94-
- Run `npm run dev:prepare` to generate type stubs.
91+
1. Clone this repository.
92+
2. Install dependencies using `npm install`.
93+
3. Run `npm run dev:prepare` to generate type stubs.
94+
4. Use `npm run dev` to start [playground](./playground) in development mode.
95+
5. Update baseURL setting in Nuxt config with [Lupus Decoupled Drupal](https://www.drupal.org/project/lupus_decoupled) instance URL and append the API-prefix /ce-api, e.g. `https://8080-shaal-drupalpod-8m3z0ms7mb6.ws-eu67.gitpod.io/ce-api`
96+
97+
### Run on StackBlitz
98+
99+
1. [Launch it on StackBlitz](https://stackblitz.com/fork/github/drunomics/nuxtjs-drupal-ce/tree/2.x?startScript=dev:prepare,dev&file=playground/nuxt.config.ts)
100+
2. Update baseURL setting in Nuxt config with [Lupus Decoupled Drupal](https://www.drupal.org/project/lupus_decoupled) instance URL and append the API-prefix /ce-api, e.g. `https://8080-shaal-drupalpod-8m3z0ms7mb6.ws-eu67.gitpod.io/ce-api`
95101

96102

97103
## License

0 commit comments

Comments
 (0)