Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uvacoder/uva-nuxtmodules-collection-v1


https://github.com/uvacoder/uva-nuxtmodules-collection-v1

abcaaa abccollection abcstarter abcwip collection curated mywip nuxt nuxtjs tailwindcss vue

Last synced: 29 days ago
JSON representation

Awesome Lists containing this project

README

        

[![nuxt/modules](https://modules.nuxtjs.org/preview.png)](https://modules.nuxtjs.org)

> Official and community [Nuxt](https://nuxtjs.org) modules united on [modules.nuxtjs.org](https://modules.nuxtjs.org)

# Nuxt Modules

[![automated](https://flat.badgen.net/badge/publish/automated/green)](#)
[![npm version](https://flat.badgen.net/npm/v/@nuxt/modules)](https://www.npmjs.com/package/@nuxt/modules)

## Contributing

- If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
- If some meta is wrong, feel free directly opening a pull request

### 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 `dist/module.json`

```
yarn build
```

## Module Usage

You can use the `@nuxt/modules` package by installing it in your project:

```bash
npm install @nuxt/modules
# Or yarn add @nuxt/modules
```

Then you can directly import the list of modules:

```js
const modules = require('@nuxt/modules')
// modules is an array of objects
// See https://unpkg.com/@nuxt/modules/dist/modules.json
```

## Website

### Development

Start Nuxt in development:

```bash
yarn dev
```

Then visit http://localhost:3000.

In development, the npm downloads and GitHub stars will be mocked.

### Production

Create a [personnal GitHub token](https://github.com/settings/tokens) (no scope selected) and add it to `.env`:

```bash
# .env
GITHUB_TOKEN=
```

Generate the website:

```
yarn generate
```

Start the production website:

```bash
yarn start
```

## License

MIT Nuxt.js Team