Aphrodite

SayaKaya React UI Library

Currently used in:

• Persephone (Sales Dashboard)
• Isis (CMS)

• Development
  • Install Node.js
    • For Debian and it's derivatives
    • For Windows
  • Clone this repository
  • Install required packages
  • Run Storybook
  • Use in Local Project
    • Build
    • Create .tgz Package
    • Installation
• Publishing
  • Login
  • Update the version
  • Build
  • Publish
• How to Use
  • Installation
  • Usage

Development

Install Node.js

For Debian and it's derivatives

Download the n script to help with installing Node. You can check the source on GitHub here

curl -L https://git.io/n-install | bash

Install the latest LTS release or at least version 18

n lts
# or
n 18

Verify installed version

npm version

For Windows

Install node via GUI or chocholatey.

Clone this repository

git clone https://github.com/Sykyapps/aphrodite.git

Install required packages

We prefer the NPM package manager

npm install

Run Storybook

This project uses Storybook for developing and testing UI components. To start the Storybook server, run:

npm run storybook

Use in Local Project

You can use this library in your project without publishing it to npm by creating a package in your local machine

Note: You will need to publish the library to npm before you push your project to repository. After you follow the "Publishing" guide, you can reinstall the package in your project from npm by following the "How To Use" guide

Build

Build the library by running:

npm run build

Create .tgz Package

Create a local package from the build by running:

npm pack

Installation

Copy the .tgz file to your project directory, then install the package in your project by running:

npm install /path/to/sayakaya-aphrodite-x.y.z.tgz

Publishing

Login

Before publishing this library, you'll need to login using [email protected] npm account in your local npm CLI, run:

npm login
# use login via browser

Insert the credential from this page

Note: No need to login again if you've already logged in to [email protected] before.

Update the version

Update the version in package.json file

{
  ...
  "version": "x.y.z",
  ...
}

Build

Build the library by running:

npm run build

Publish

Then, you can publish the library by running:

npm publish --access public

How to Use

After publishing the library, you can install it in your project

Installation

To install this library, you can use npm:

npm install @sayakaya/aphrodite [email protected]

Or, if you prefer yarn:

yarn add @sayakaya/aphrodite [email protected]

Usage

Here's a basic example of how to use this library:

import { Button } from '@sayakaya/aphrodite';

export default () => (
  <>
    <Button buttonVariant="primary">PRESS ME</Button>
  </>
);