https://github.com/thombruce/rockband

🎸 UI kit and utilities for Vue and Nuxt
https://github.com/thombruce/rockband

Last synced: 1 day ago
JSON representation

🎸 UI kit and utilities for Vue and Nuxt

• Host: GitHub
• URL: https://github.com/thombruce/rockband
• Owner: thombruce
• License: mit
• Created: 2022-01-23T14:28:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-01T16:25:16.000Z (almost 3 years ago)
• Last Synced: 2024-05-01T13:15:21.816Z (8 months ago)
• Language: Vue
• Homepage: https://thombruce.github.io/rockband/
• Size: 25.2 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RockBand

## Features

RockBand is a Nuxt component library that comes with:

- [Nuxt Image](https://image.nuxtjs.org/)

- [Pug](https://pugjs.org/api/getting-started.html)

- [Tailwind CSS](https://tailwindcss.com/) + [Tailwind CSS Forms](https://github.com/tailwindlabs/tailwindcss-forms)

- [PostCSS](https://postcss.org/)

- [Font Awesome](https://fontawesome.com/)

- [Simple Icons](https://simpleicons.org/)

- [Lodash](https://lodash.com/)

- [Nuxt Taxonomies](https://github.com/thombruce/nuxt-taxonomies)

These are used to create a base set of components and plugins for my Nuxt projects.

## Installation

### Vue CLI

Add RockBand to your project and run the initializer:

```sh

vue add @rockband/ui

```

### Nuxt

Add RockBand to your project:

```sh

yarn add --dev @rockband/nuxt

```

Add RockBand to buildModules in `nuxt.config.js`:

```js

buildModules: [

  '@rockband/nuxt'

]

```

## Overwrite Default Styles

Create a CSS file at `assets/css/rockband.css` and import `@rockband/vue`:

```css

@import "@rockband/vue";

/* Declare your styles or local imports here. */

```

RockBand comes with Tailwind CSS and PostCSS; you can count on both of them working for this file and its imports. And of course, you can just write plain old CSS.

You can also configure `tailwind.config.js` following their docs. Apart from the `rockband.css` file, it's just like any other Tailwind installation.

## Development

This project uses Yarn Workspaces and Lerna in development.

### Publishing

```sh

lerna build

lerna publish

```