https://github.com/pimp-my-book/narshik
GOA's Design System Components written in VueJS 🍶
https://github.com/pimp-my-book/narshik
design-systems javascript storybook tailwindcss vuejs
Last synced: 4 months ago
JSON representation
GOA's Design System Components written in VueJS 🍶
- Host: GitHub
- URL: https://github.com/pimp-my-book/narshik
- Owner: pimp-my-book
- Created: 2019-03-08T12:59:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T05:23:20.000Z (over 2 years ago)
- Last Synced: 2025-02-07T08:50:16.909Z (4 months ago)
- Topics: design-systems, javascript, storybook, tailwindcss, vuejs
- Language: JavaScript
- Homepage: https://narshik.netlify.com
- Size: 2.62 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Narshik ⛰️
This is a Vue component library based off of the Design System for [GOA](https://gogoa.co.za), Pimp My Book's bursary management app.
The Design System can be viewed on [Figma](https://www.figma.com/file/KedEPuWZk0CXWWNAEf806cOZ/GOA?node-id=0%3A1).
### 🎉 Features
* Range of basic components to make a basic application
* Uses TailwindCSS
* Storybook setup to view components during development
* Integration with Bit (Coming Soooooon)
## 📦 Project setup
You can easily install the library via NPM or Yarn:
**npm**
```
$ npm install narshik
```
**yarn**
```
$ yarn add narshik
```
## 🌪️ Usage
You can import the components like so by importing the lib and it's CSS in your `main.js` file:
```
import Vue from "vue";
import "narshik";
import "narshik/dist/narshik.css";
import App from "./App.vue";
Vue.config.productionTip = false;
new Vue({
render: h => h(App)
}).$mount("#app");
```
Then you can import any of the components like so:
```
//App.vue
```
## 🧜♂️Local Development
### Make sure you clone the lib then install all the depencenices:
```
$ yarn install
```
### Compiles and minifies for production
```
$ yarn run build
```
### Run your tests
```
$ yarn run test
```
### Lints and fixes files
```
$ yarn run lint
```