motofin-ui

motofin-ui

A React Component Library for Building MotoFin360 Design Components

Documentation

Go to https://motofin.eks.stg.ap-southeast-1.horizontals.olx.org/

Description

Tech Stack -

• TypeScript
• SASS
• React Testing Library + Jest
• Storybook
• React JS

Install

Using yarn:

yarn add motofin-ui

Using npm:

npm install motofin-ui

How to use

Before adding the package in your repository, .npmrc is needed in your project root with following content. (Global .npmrc is required with JFrog creds )

registry=https://olx.jfrog.io/olx/api/npm/nc-regional-almea-panamera-npm/
save-exact=true
always-auth=true

Getting started

In order to get your instance up and running you must:

1. Clone this repo - https://git.naspersclassifieds.com/panamera/consumer-finance/motofin-ui.git
2. Install dependencies yarn install
3. Run yarn storybook

Avalaible Commands

Use the following commands :

• Development mode: yarn storybook
• Run the unit test suite: yarn test
• Run the unit test suite and watch for files in order to re-run tests automatically: yarn test:watch
• Get a coverage report: yarn test:coverage
• Storybook Development: yarn story:dev
• Build Storybook: yarn build-storybook
• Run Es-Lint: yarn lint

Contributing

Please refer to project's style and contribution guidelines for submitting patches and additions. In general, we follow the following process.

1. Clone the project to your own machine
2. Add Your changes and Test Cases for the newly added code (Very IMPORTANT)
3. Commit changes to your own branch
4. Push your work back up to the repo
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Authors and acknowledgment

Contributing Authors -

1. Nitin Mishra - [e-mail]
2. Somyanath Mohanty - [e-mail]
3. Yash Mishra - [e-mail]
4. Arunava Modak - [e-mail]
5. Anil Jangra - [e-mail]
6. Nidhi Deswal - [e-mail]
7. Praveen Sharma - [e-mail]
8. Aayush Goyal - [e-mail]
9. Ria Soam - [e-mail]