dx-customer-engineering-poc-component-library v1.1.3

About The Project

A reusable React component library to streamline and enable faster POC development in Experience Platform. Refer to the wiki here for more info.

Built With

• React.js
• React Spectrum
• Storybook
• Webpack
• Sass

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/your_username_/poc-component-library.git

2. Install NPM packages

   npm install

3. Add your changes and test in Storybook

   yarn start or yarn storybook

Usage

Add the below import statement to the top of your file:

import ComponentName from 'dx-customer-engineering-poc-component-library'

Then you can use it in your project

<ComponentName prop1={} prop2={} ... />

*Run npm update to get the latest version of each component

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)

Add your component in src -> components -> New Component Name Export component in src -> index.js Run npx parcel build

3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

To publish to NPM: npm version newVersionNumber --no-git-tag-version npm publish

Contact

Jess Peng - jesspeng@adobe.com

Project Link: https://git.corp.adobe.com/jesspeng/poc-component-library

Acknowledgments

• Creating a reusable Component Library with React, Storybook, and Webpack