@sparkpointio/sparkswap-uikit

SparkSwap UIkit

SparkSwap UIkit is a set of React components and hooks used to build pages on Pancake's apps. It also contains a theme file for dark and light mode.

1. Install

1.a With Yarn

yarn add @sparkpointio/sparkswap-uikit

1.b With NPM

npm install @sparkpointio/sparkswap-uikit

2. Setup

2.a Theme

Before using SparkSwap UIkit, you need to provide the theme file to styled-component.

import { ThemeProvider } from 'styled-components'

import { light, dark } from '@aldrickb/sparkswap-uikit

...

<ThemeProvider theme={isDark}>...</ThemeProvider>

2.b Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@aldrickb/sparkswap-uikit'

...

<ResetCSS />

3. Types

This project is built with Typescript and export all the relevant types.

4. Devs Section

How to start contributing

1. Clone Repository

git clone https://github.com/sparkpointio/sparkswap-uikit.git

2. Open Directory

cd sparkswap-uikit

3. Install Dependencies: Yarn recommended

yarn install

4. Create working repository from develop

git checkout develop
git branch [branch name]

5. Commit changes with message formatting - Husky https://github.com/conventional-changelog/commitlint

ex: 
1. chore: Run tests on travis ci
2. fix(server): Send cors headers
3. feat(blog): Add comment section
4. docs: Update README.md

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

1. build
2. ci
3. chore
4. docs
5. feat
6. fix
7. perf
8. refactor
9. revert
10. style
11. test

Library

SparkSwap UIKit - Github

SparkSwap UIKit - NPM

View storybook