Welcome to Mockline, your go-to design library crafted to elevate your creative journey. Whether you're a seasoned designer or a budding developer, Mockline is designed to empower you with efficient, innovative, and collaborative tools, putting the joy back into the design process.

Getting Started

Visit mockline.dev to get started with Mockline.

Contributing

See CONTRIBUTING.md for more information.

Community

The Mockline community can be found on Discord, to chat with other community members, you can join the Mockline Discord.

Features

• Fully customizable: All components are customizable via props and slots.
• Lightweight: No external CSS file. All styles are generated via Tailwind CSS.
• Fully typed: Written in TypeScript with predictable static types.
• Developer friendly: Fully documented and easy to contribute.
• SSR: Server-side rendering supported.
• Dark mode: Dark mode supported.

Quick Setup

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:

1. Add mockline dependency to your project

# Using bun
bun install -D mockline

# Using pnpm
pnpm add -D mockline

# Using yarn
yarn add --dev mockline

# Using npm
npm install --save-dev mockline

2. Add @nuxtjs/mockline to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'mockline'
  ]
})

That's it! You can now use Mockline in your Nuxt app ✨

Local development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using bun install

Contributing

To start contributing, you can follow these steps:

1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, feat/123 or fix/456.
4. Make changes following the local development steps.
5. Commit your changes following the Conventional Commits specification.
6. If your changes affect the code, run tests using bun run test.
7. 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.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !

Published under the APACHE license. Made by @HugoRCD and community 💛

🤖 auto updated with automd (last updated: Mon Apr 15 2024)