Skip to content

Commit 9b7da2b

Browse files
committed
chore(readme): add minimal-starter; improve readme
1 parent e900c9a commit 9b7da2b

File tree

8 files changed

+6088
-9
lines changed

8 files changed

+6088
-9
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,52 @@ pnpm stub
6161
cd playground && pnpm run dev
6262
```
6363

64+
## Module options
65+
66+
You can configure any behavior from the module from your `nuxt.config.ts` file:
67+
68+
```typescript
69+
export default defineNuxtConfig({
70+
modules: ['nuxt-edgedb-module'],
71+
edgeDb: {
72+
// Devtools integrations
73+
devtools: true,
74+
// Completely toggle watchers feature
75+
watch: true,
76+
// Enable or disable prompts on watch events
77+
watchPrompt: true,
78+
// Generate target for your queries and query builder
79+
generateTarget: 'ts',
80+
// dbschema/ dir (you should not touch this)
81+
dbschemaDir: 'dbschema',
82+
// dbschema/ dir (you should not touch this)
83+
queriesDir: 'queries',
84+
// dbschema/ dir (you should not touch this)
85+
queryBuilderDir: 'dbschema/query-builder',
86+
// Toggles typings generation (@db/interfaces)
87+
generateInterfaces: true,
88+
// Toggles typings generation (@db/queries)
89+
generateQueries: true,
90+
// Toggles typings generation (@db/builder)
91+
generateQueryBuilder: true,
92+
// Toggles logging messages on code generation
93+
generateQuiet: true,
94+
// Toggles project init wizard
95+
projectInit: true,
96+
// Toggle CLI install wizard
97+
installCli: true,
98+
// Toggles composables
99+
composables: true,
100+
// Toggles auto-injection on auth credentials
101+
injectDbCredentials: true,
102+
// Enables authentication intergation
103+
auth: false,
104+
// Enables oauth intergation
105+
oauth: false,
106+
}
107+
})
108+
```
109+
64110
## Server usage
65111

66112
The module provides auto-imported composables available anywhere inside `server/` context of your Nuxt app.

minimal-starter/app.vue

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<script setup lang="ts">
2+
3+
</script>
4+
5+
<template>
6+
<div>
7+
Hello world
8+
</div>
9+
</template>

minimal-starter/nuxt.config.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default defineNuxtConfig({
2+
modules: [
3+
'../src/module'
4+
],
5+
edgeDb: {
6+
auth: true,
7+
oauth: true
8+
},
9+
devtools: { enabled: true }
10+
})

minimal-starter/package.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"private": true,
3+
"name": "my-module-playground",
4+
"type": "module",
5+
"scripts": {
6+
"dev": "nuxi dev",
7+
"build": "nuxi build",
8+
"generate": "nuxi generate"
9+
},
10+
"devDependencies": {
11+
"@nuxt/devtools": "latest",
12+
"nuxt": "latest"
13+
},
14+
"dependencies": {
15+
"@edgedb/generate": "^0.4.1"
16+
}
17+
}

0 commit comments

Comments
 (0)