@currently-apps/currently-components

Currently Components

Currently Components is a component library built with React, Storybook, TailwindCSS, and daisyUI.

It provides a collection of reusable UI components that can be easily integrated into the rest of the currently apps ecosystem.

This library was scaffolded and setup using this reference tutorial here.

Installation

To use Currently Components in your project, make sure you have Node.js version 21.7.1 or later installed. Then, follow these steps:

• Install the library using npm:

  npm install @currently-apps/currently-components
  

  Replace @currently-apps with the appropriate npm scope.

• Import the components in your React application:

  import { Button, Card, Input } from '@currently-apps/currently-components';
  

• Start using the components in your application:

  function App() {
    return (
      <div>
        <Button>Click me!</Button>
        <Card>
          <Input placeholder="Enter your name" />
        </Card>
      </div>
    );
  }
  

Development

If you want to contribute to Currently Components or customize the library for your specific needs, you can follow these steps to set up the development environment:

• Clone the repository:

  git clone https://github.com/your-username/currently-components.git
  

• Navigate to the project directory:

  cd currently-components
  

• Install the dependencies:

  npm install
  

• Start the development server and Storybook:

  npm run dev
  

  npm run storybook
  

  This will start the development server and open Storybook in your browser, where you can view and interact with the components.

• Make changes to the components in the lib directory. Any changes you make will be reflected in the Storybook's and local dev server's live reload.

• Build the library for production:

  npm run build
  

  This will generate the transpiled and optimized library files in the dist directory. Publishing will also build the library automatically.

• Publish the library to npm:

  npm publish
  

  Note: Make sure to update the version number in the package.json file before publishing.

Documentation

For detailed documentation and usage examples of each component, refer to the Storybook documentation generated for Currently Components. You can access the Storybook documentation by running the development server as mentioned in the Development section and navigating to the provided URL.

License

Still figuring out licensing

Note: This project uses Node.js version 21.7.1. Please ensure you have this version or a compatible version installed before running the project.