@abigcircle/base-ui v0.0.2

ABC Base UI

A brief description of your package and its purpose.

Table of Contents

• Installation
• Usage
• Building
• Contributing
• License

Installation

To use this package, you can install it directly from the GitHub repository. Run the following command:

npm install git+https://github.com/abigcircle/abc-base-ui.git

Note for Private Repositories

If the repository is private, ensure you have the necessary authentication set up (SSH keys or personal access tokens).

Usage

After installing the package, you can import and use it in your project. Here's an example:

import { Button } from "your-package-name";

// Use the Button component in your application
const App = () => (
  <div>
    <Button label="Click Me" />
  </div>
);

Building

If you cloned the repository and want to build the package yourself, follow these steps:

1. Clone the repository:

   git clone https://github.com/username/repo-name.git
   cd repo-name

2. Install dependencies:

   npm install

3. Build the package:

   npm run build

This will generate the necessary build files in the dist directory.

Git Flow

This project uses Git hooks to automate the build process. The package will automatically build before each commit, ensuring that the latest changes are always compiled.

Continuous Integration

The project is set up with GitHub Actions to automatically build the package on pushes and pull requests to the main branch. This ensures that the package is always in a deployable state.

Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Create a pull request to the main repository.

Code of Conduct

Please adhere to the Code of Conduct in all interactions.

License

This project is licensed under the MIT License - see the LICENSE file for details.