maiton (alpha)

Simple and customizable components that you can copy and paste for building Farcaster frames fast. maiton is free and open-source. Use it to build your own Farcaster frame components.

Documentation

Visit https://maiton.xyz for the full documentation.

Installation

To install maiton, run:

pnpm install maiton

Usage

To use maiton, first you need to initialize the project:

pnpm maiton init

This command installs dependencies and adds the cn util for the project.

Then, you can add components to your project:

pnpm maiton add [component]

For example:

pnpm maiton add avatar

Or you can run the command without any arguments to view a list of all available components:

pnpm maiton add

Enjoy building your Farcaster frame with maiton 🥳

Components

• Avatar: A simple circle avatar.
• Row: A horizontal flex container for layout.
• Column: A vertical flex container for layout.
• Container: A wrapper component with customizable padding.
• Address: A component to display and format blockchain addresses.
• Text: A customizable text component with various styles and sizes.
• Background Image: A component to add and style background images.
• Badge: A small label component for status or categories.
• Banner: A full-width component for important announcements or messages.
• Progress: A progress bar component to show completion status.
• Transaction Result: A component to display blockchain transaction outcomes.
• User Banner: A banner component displaying user information and details.
• Card: A versatile container component with optional header and footer.

Development

Just follow these steps:

1. Clone the repo

git clone git@github.com:builders-garden/maiton-ui.git

2. Install the dependencies

pnpm install

3. Start the development server

pnpm dev

Contributing

Please read the contributing guide.

License

Licensed under the MIT license.