BeTokyo UI Components Libray

Welcome to the BeTokyo UI Components Library! This library is designed to provide a collection of reusable UI components that can be easily integrated into BeTokyo web applications. It aims to simplify the development process by offering a consistent and visually appealing set of components.

Getting Started

To use this library in your Angular project, follow the steps below:

Installation

1. Start by cloning the repository to your local machine using the following command:

   git clone https://github.com/JohnDoe-LTD/be-tokyo-design-system.git

2. Change into the project directory:

   cd be-tokyo-design-system

3. Install the necessary dependencies using npm:

   npm install

Usage

To start using the UI components in your Angular application, you need to import the module into your project and add the desired components to your templates. Follow the steps below:

1. Open your Angular project in your preferred code editor.

2. In your project's module file (e.g., app.module.ts), import the BeTokyoModule from the library:

   import { BeTokyoModule } from '@betokyo/ui-components';
   
   @NgModule({
     imports: [
       // Other imports...
       BeTokyoModule
     ],
     // ...
   })
   export class AppModule { }

3. In your Angular component templates, you can now use the UI components by adding the appropriate tags. For example:

   <ui-button (click)="handleClick()">Click Me</ui-button>

   You can explore the available components and their usage by referring to the library's documentation.

Documentation

To learn more about the available UI components and their usage, please refer to the documentation provided with this library. The documentation includes detailed information about each component, their input/output properties, and examples demonstrating their usage.

Storybook

We have also included Storybook as part of this library to provide a visual development environment for the UI components. To start Storybook, run the following command:

npm run storybook

This will open Storybook in your browser, where you can interact with the components, view different states, and test their functionalities. Storybook serves as a valuable tool for component development and documentation.

Contributing

Contributions to the BeTokyo UI Components Library are welcome! If you have any ideas for new components, improvements, or bug fixes, please submit a pull request on the repository. Be sure to follow the existing coding style and guidelines.

License

This library is released under the MIT License. You are free to use, modify, and distribute the code for both commercial and non-commercial purposes. Please review the license file for more details.

Acknowledgments

This project was developed as part of a school project by BeTokyo Team. Special thanks to @JohnDoe for their guidance and support throughout the development process.

If you have any questions or encounter any issues while using this library, please feel free to reach out to [email protected].

Happy coding!