Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 2 months ago
JSON representation

The Awes.io Frontend Framework.

Awesome Lists containing this project

README

        



Awes.io logo

Client UI

>

The Awes.io Frontend Framework. Π‘onsists of UI, Profile, Auth and else.



Last version


License


vue


Last commit


Analytics


Hosted by Package Kit


Patreon

##

#### 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
```