For the moment Mockline is only available for Nuxt projects (Vue 3 support and react support will be added soon). To get started, follow these steps:
- Add
@mockline/utils
dependency to your project
# Using bun
bun install -D @mockline/utils
# Using pnpm
pnpm add -D @mockline/utils
# Using yarn
yarn add --dev @mockline/utils
# Using npm
npm install --save-dev @mockline/utils
- Add
@mockline/utils
to themodules
section ofnuxt.config.ts
export default defineNuxtConfig({
modules: [
'@mockline/utils'
]
})
That's it! You can now use Mockline in your Nuxt app ✨
The Mockline community can be found on Discord, to chat with other community members, you can join the Mockline Discord.
To start contributing, you can follow these steps:
- First raise an issue to discuss the changes you would like to make.
- Fork the repository.
- Create a branch using conventional commits and the issue number as the branch name. For example,
feat/123
orfix/456
. - Make changes following the local development steps.
- Commit your changes following the Conventional Commits specification.
- If your changes affect the code, run tests using
bun run test
. - Create a pull request following the Pull Request Template.
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
- Wait for the maintainers to review your pull request.
- Once approved, the pull request will be merged in the next release !
Local development
Published under the APACHE license.
Made by @HugoRCD and community 💛
🤖 auto updated with automd (last updated: Mon Aug 19 2024)