@jasonrundell/dropship
v2.9.3
Published
Get a React project up and running really fast with Dropship.
Downloads
822
Readme
Dropship
Dropship is a component library designed to provide reusable UI components for your projects. It includes a variety of atoms, molecules, and organisms to help you build consistent and maintainable user interfaces.
Storybook
You can see the latest build of Dropship on Storybook at https://dropship-storybook.vercel.app/.
Installation
You can install Dropship via npm. To install the package, run:
npm install @jasonrundell/dropship
To install the project dependencies for development, run:
npm install
Usage
To start the development server and view the components in Storybook, run:
npm run storybook
Atoms
Atoms are the basic building blocks of a user interface. They include elements like buttons, inputs, and links. Here are all of the atoms included in Dropship:
- Blockquote
- Box
- Button
- Container
- Grid
- Heading
- Link
- Row
- Spacer
Storybook
This project uses Storybook for developing and showcasing components. You can find stories for various components in the src/stories directory.
Scripts
Here are some useful scripts you can run:
npm run build
: Builds the project.npm run start
: Starts the development server.npm run test
: Runs the tests.npm run storybook
: Starts the Storybook server.
Contributing
If you would like to contribute, please follow the contributing guidelines.
License
This project is licensed under the MIT License. See the LICENSE file for details.