https://github.com/uvacoder/uva-nuxtmodules-collection-v2
https://github.com/uvacoder/uva-nuxtmodules-collection-v2
abcaaa abccollection abcstarter abcwip collection curated myresources mysite mywip nuxtjs vercel
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/uvacoder/uva-nuxtmodules-collection-v2
- Owner: Uvacoder
- License: mit
- Created: 2021-11-17T08:31:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T15:15:44.000Z (over 2 years ago)
- Last Synced: 2025-06-12T23:41:28.526Z (4 months ago)
- Topics: abcaaa, abccollection, abcstarter, abcwip, collection, curated, myresources, mysite, mywip, nuxtjs, vercel
- Language: Vue
- Homepage: https://abc-nuxtmodulesnew.vercel.app/
- Size: 4.14 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Modules
--
[](#)
[](https://www.npmjs.com/package/@nuxt/modules)
> Discover Nuxt modules to supercharge your project! Created by the Nuxt team and community.
👉 https://modules.nuxtjs.org
## Modules Database
Metadata of nuxt modules are maintained in [yml](https://en.wikipedia.org/wiki/YAML) files inside [./modules](./modules) directory and automatically synced from upstream to fetch latest information.
### Contribution
- If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
- If some data is outdated please directly open a pull request
### Using CDN
Compiled JSON data is available from following CDNs:
- **jsdelivr:**: https://cdn.jsdelivr.net/npm/@nuxt/modules@latest/modules.json
- **unpkg:** https://unpkg.com/@nuxt/modules@latest/modules.json
### Using npm package
You can use the `@nuxt/modules` package by installing it in your project:
```bash
# npm
npm install @nuxt/modules
# yarn
yarn add @nuxt/modules
```
Then you can directly import the list of modules:
```js
// ESM
import modules from '@nuxt/modules'
// CommonJS
const modules = require('@nuxt/modules')
```
### Schema
Field Name | Auto sync | Description
----------------|-----------|--------------
`name` | No | Canonical name or integration name
`description` | Yes | Short description
`repo` | No | Github repository. Format is `org/name` or `org/name#main/path`
`npm` | Yes | NPM package name
`icon` | No | Icon of module from [./website/static/icons](./website/static/icons) directory
`github` | No | Github URL
`website` | No | Website URL
`learn_more` | No | Link to learn more (website or relevant integration website)
`category` | No | Module category from [./lib/categories.json](./lib/categories.json)
`type` | No | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
`maintainers` | Yes | List of maintainers each item has `name`, `github` and `avatar`
`compatibility` | No | Module compatibility status. Valid keys are `2.x`, `2.x-bridge` and `3.x` and valid values are `working`, `wip`, `unknown`, `not-working`. Please see [this discussion](https://github.com/nuxt/framework/discussions/751) for more information.
## Maintenance
### Add or update repository
```bash
yarn sync
```
Example: `yarn sync tailwindcss nuxt-community/tailwindcss-module`
To sync with a branch different than `master`, suffix the repo with `#repo-branch`, example: `yarn sync tailwindcss nuxt-community/tailwindcss-module#dev`
### Auto update all current modules
```bash
yarn sync
```
### Generate `npm/modules.json`
```sh
yarn build
```
## Website development
- Clone repository
- Install website depenedencies using `npx yarn install`
Start development:
```bash
npx yarn dev
```
Then visit http://localhost:3000
In the development, the npm downloads and GitHub stars will be mocked unless setting `USE_NUXT_API` variable.
## License
[MIT](./LICENSE) - Made by Nuxt Team