Skip to content

Latest commit

 

History

History
108 lines (69 loc) · 2.72 KB

README.md

File metadata and controls

108 lines (69 loc) · 2.72 KB
Raw

Turbolibs 🚀

License: MIT

Welcome to Turbo Libraries! This monorepo is dedicated to providing high-performance and optimized libraries for modern web development.

📚 Table of Contents

🌟 Overview

Turbo Libraries aim to deliver speed and efficiency in every aspect of web development. Our goal is to help developers build fast, scalable, and maintainable applications with ease. Whether you need UI components, CSS frameworks, utility libraries, or any other type of development tool, Turbolibs has you covered.

Note: The project is currently under active development. Stay tuned for updates!

🏁 Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js >= 22.x
  • npm >= 10.x or yarn >= v1.22.x

Installation

To get started with our libraries, follow these steps:

  1. Clone the repository:

    git clone https://github.com/PabloAballe/turbolibs.git
cd speedopt

  2. Install dependencies:

    npm install
# or
yarn install

  3. Build the project:

    npm run build
# or
yarn build

📦 Current Libraries

🔧 Development

To contribute to this project, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-feature-branch
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-feature-branch
  5. Submit a pull request.

Running Tests 🧪

We use Jest for unit tests. To run the tests, use:

npm run test
# or
yarn test

Storybook 📚

We use Storybook for developing and testing UI components. To start Storybook, run:

npm run storybook
# or
yarn storybook

🤝 Contributing

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

Please see our CONTRIBUTING.md for more information.

📄 License

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

This README was generated with ❤️ by Pablo Aballe