iamaravinds / golem-components

A Library of components for a full fledged Web development for Vue3

Golem Components

A Library of components for a full fledged Web development

Golem Components support only for Vue 3.

Prerequisites

This project requires NodeJS (version 14 or later) and a Vue 3. Node and NPM are really easy to install.

Table of contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
    • Registering with the app
  • Contributing
  • Authors
  • Built With
  • License

Getting Started

Golem is an awesome library which is at seed level now. The goel is to roll over the web app like a golem to build robust strong components.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Install Golem Components in your application:

Using npm

$ npm i golem-components

Using yarn

$ yarn add golem-components

Usage

Registering with the app

main.js

import GolemComponents from 'golem-components';
import 'golem-components/dist/style.css';

import App from './App.vue';

const app = createApp(App);

app.use(GolemComponents);

app.mount('#app');

Using the components

Just start using the components here and thats it!!!!

App.vue

<GButton>Click me 🐷</GButton>

<GButton expanded>I am Fat 🐷</GButton>

<GInput />

<GInput placeholder='Secret here!! 🤫' type="password" />

<GSearch
@search='alertItem'
/>

<GSearch
  :category="[
    'Pokemon',
    'Dragon Ball Z',
    'Naruto',
  ]"
  @search='alertItem'
/>

Contributing

1. Fork it on github!
2. Create your feature branch: git checkout -b my-new-component
3. Add your changes: git add .
4. Commit your changes: git commit -am 'New component with details'
5. Push to the branch: git push origin my-new-component
6. Submit a pull request 😎

Authors

• Aravind S - Initial work - iamaravinds

See also the list of contributors who participated in this project.

Built With

• Vue 3
• Tailwind CSS
• VS Code
• and Love ❤️

License

MIT