https://github.com/hardpixel/nuxt-db
Nuxt database module acting as Git-based Headless CMS.
https://github.com/hardpixel/nuxt-db
Last synced: 9 months ago
JSON representation
Nuxt database module acting as Git-based Headless CMS.
- Host: GitHub
- URL: https://github.com/hardpixel/nuxt-db
- Owner: hardpixel
- License: mit
- Created: 2022-09-03T05:51:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T06:10:23.000Z (over 1 year ago)
- Last Synced: 2025-03-27T09:05:04.963Z (about 1 year ago)
- Language: JavaScript
- Size: 733 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Nuxt DB
Nuxt database module acting as Git-based Headless CMS.
[](https://github.com/hardpixel/nuxt-db/actions/workflows/build.yml)
## Installation
1. Add the `nuxt-db` dependency with `yarn` or `npm` to your project
2. Add `nuxt-db` to the `modules` section of `nuxt.config.js`
3. Configure it:
```js
{
modules: [
// Simple usage
'nuxt-db',
// With options
['nuxt-db', { dir: 'content' }]
]
}
```
or add top level options
```js
{
database: {
dir: 'content'
}
}
```
## Development
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Start development server using `npm run dev`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/nuxt-db.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).