ATD DTS ADMIN COMPONENTS & THEME

Visit the Component Documentation (aka Storybook) here

Our Storybook instance is hosted on Chromatic. Here is Storybook deployment documentation.

Made with create-react-library

Install

npm install --save atd-kickstand

Usage

import React, { Component } from "react";

import MyComponent from "atd-kickstand";
import "atd-kickstand/dist/index.css";

class Example extends Component {
  render() {
    return <MyComponent />;
  }
}

Local Development

Local development involves running rollup in watch mode from the root project folder and running the built-in React app in /example/ concurrently. This will automatically compile new changes to the library in to /dist/ folder and make them available for import in the example app.

To run rollup in watch mode, in the root project folder, run:

npm start

Then, to start the example app developement server in a separate tab or terminal, run:

cd example npm install (only first time) npm start

Importing in a separate repository for local development

To import this library into another local repository, run:

npm install --save cityofaustin/atd-kickstand#<branch name>

The branch name can point to main or another branch that you are developing.

---

Storybook

Running locally

yarn storybook

http://localhost:6006/

Test

yarn test

Generate static build

yarn build-storybook

Developing components

1. Create a React component and test file in /src/components
2. Create a storybook file in src/stories

---

License

MIT ©