Atomic Component: Buttons

Atomic Component's button collection offers a powerful toolkit for crafting the perfect call-to-action elements for your web interfaces.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This collection of button components adheres to the principles of Atomic Design. Each button is constructed as a self-contained, and reusable element. This modular approach allows for maximum flexibility and ease of customization when building out your web interfaces.

(back to top)

Built With

(back to top)

⛳ Getting Started

Prerequisites

Please ensure you have Node.js installed on your machine, version 18 or greater. You can download it from the official website NodeJs.

Clone starter-template into a new folder

mkdir new-project-name && cd $_

git clone --depth=1 https://github.com/BrinsilElias/button-stack.git && rm -rf ./.git

OR (essentially the same thing with npx + degit)

npx degit BrinsilElias/button-stack#main

Install tools and spin it up

1. npm i or npm install - Install all dependencies
2. npm start - Start the development Server
3. npm run build - Build static assets

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

🚧 Roadmap

See the open issues for a list of proposed features (and known issues).

(back to top)

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
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

(back to top)

📝 License

Distributed under the MIT License. See LICENSE for more information.

📫 Contact

Brinsil Elias - @BrinsilE

Project Link: https://github.com/BrinsilElias/button-stack

Acknowledgements

• open-props
• Adam Argyle

(back to top)