https://github.com/awes-io/client

The Awes.io Frontend Framework.
https://github.com/awes-io/client

awes-io nuxt nuxt-module ui ui-design uikit

Last synced: about 1 month ago
JSON representation

The Awes.io Frontend Framework.

• Host: GitHub
• URL: https://github.com/awes-io/client
• Owner: awes-io
• Created: 2020-01-03T18:19:31.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-07T16:15:58.000Z (over 1 year ago)
• Last Synced: 2024-10-03T16:34:39.913Z (about 1 month ago)
• Topics: awes-io, nuxt, nuxt-module, ui, ui-design, uikit
• Language: Vue
• Homepage: https://www.awes.io
• Size: 6.85 MB
• Stars: 8
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    

        

    



Client UI


> 
The Awes.io Frontend Framework. Сonsists of UI, Profile, Auth and else.




    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



##

#### Content

1. 📦 [Packages](#packages)

2. 🌱 [Local installation](#how-to-install-client-to-your-local-machine)

3. 📖 [How build a new component for UI](#how-build-a-new-component-for-ui)

4. 🎉 [Release new versions](#release-new-versions)

## Packages

| Package | Version | Downloads |

|-----------------------|---------|-----------|

| [@awes-io/ui](https://www.npmjs.com/package/@awes-io/ui) | ![@awes-io/ui](https://img.shields.io/npm/v/@awes-io/ui) | ![@awes-io/ui](https://img.shields.io/npm/dm/@awes-io/ui) |

| [@awes-io/nuxt-auth](https://www.npmjs.com/package/@awes-io/nuxt-auth) | ![@awes-io/nuxt-auth](https://img.shields.io/npm/v/@awes-io/nuxt-auth) | ![@awes-io/nuxt-auth](https://img.shields.io/npm/dm/@awes-io/nuxt-auth) |

| [@awes-io/nuxt-profile](https://www.npmjs.com/package/@awes-io/nuxt-profile) | ![@awes-io/nuxt-profile](https://img.shields.io/npm/v/@awes-io/nuxt-profile) | ![@awes-io/nuxt-profile](https://img.shields.io/npm/dm/@awes-io/nuxt-profile) |

## How to install `client` to your local machine

```bash

# clone the repo

git clone [email protected]:awes-io/client.git

# go to project dir

cd ./client

# install all packages

yarn install

# init the lerna

lerna bootstrap

```

## Examples

### Basic UI in `dev` mode

```bash

yarn dev:eg:basic-ui

```

## Components

### UI Interfaces

```bash

yarn dev:ui

```

## Release new versions

```bash

# commit your changes into feature|bug branch

git add .

# please use commit conventional https://www.conventionalcommits.org/en/v1.0.0-beta.2/

git commit -m "COMMIT_MESSAGE"

# deploy system rest will build automaticly

git push origin YOUR_BRANCH

```

#### For manual version update use

```bash

lerna publish

```