Metadata of AdonisJS packages are maintained in yml files inside ./modules directory and automatically synced from upstream to fetch latest information.
- If you feel a package is missing, please create a new issue or open a pull request after syncing your package
- If some data is outdated please directly open a pull request
| 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 package from ./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 | Package category from ./lib/categories.ts |
type |
No | community (for adonisjs-community), official (for https://github.com/) or 3rd-party |
maintainers |
Yes | List of maintainers each item has name, github and avatar |
pnpm sync <name> <repo>Example: pnpm sync eslint adonisjs-community/eslint-plugin-adonis
To sync with a branch different than master, suffix the repo with #repo-branch, example: pnpm sync eslint adonisjs-community/eslint-plugin-adonis#dev
pnpm syncpnpm build- Clone repository
- Install website dependencies using
pnpm install -r - Start development server using
pnpm dev
Then visit http://localhost:3000
In the development, the npm downloads and GitHub stars will be mocked unless setting USE_NUXT_API variable.
- Nuxt team for developing this awesome project. https://github.com/nuxt/modules