Packages
mishka_chelekom
0.0.9
0.0.10-alpha.5
0.0.10-alpha.4
0.0.10-alpha.3
0.0.10-alpha.2
0.0.10-alpha.1
0.0.9
0.0.9-rc.2
0.0.9-rc.1
0.0.9-beta.5
0.0.9-beta.4
0.0.9-beta.3
0.0.9-beta.2
0.0.9-beta.1
0.0.9-alpha.20
0.0.9-alpha.18
0.0.9-alpha.17
0.0.9-alpha.16
0.0.9-alpha.15
0.0.9-alpha.14
0.0.9-alpha.13
0.0.9-alpha.12
0.0.9-alpha.11
0.0.9-alpha.10
0.0.9-alpha.9
0.0.9-alpha.8
0.0.9-alpha.7
0.0.9-alpha.6
0.0.9-alpha.5
0.0.9-alpha.4
0.0.9-alpha.3
0.0.9-alpha.2
0.0.9-alpha.1
0.0.8
0.0.8-rc.2
0.0.8-rc.1
0.0.8-beta.5
0.0.8-beta.4
0.0.8-beta.3
0.0.8-beta.2
0.0.8-beta.1
0.0.8-alpha.4
0.0.8-alpha.3
0.0.8-alpha.2
0.0.8-alpha.1
0.0.7
0.0.6
0.0.6-alpha.2
0.0.6-alpha.1
0.0.5
0.0.5-beta.2
0.0.5-beta.1
0.0.5-alpha.12
0.0.5-alpha.11
0.0.5-alpha.10
0.0.5-alpha.9
0.0.5-alpha.8
0.0.5-alpha.7
0.0.5-alpha.6
0.0.5-alpha.5
0.0.5-alpha.4
0.0.5-alpha.3
0.0.5-alpha.2
0.0.5-alpha.1
0.0.4
0.0.4-beta.3
0.0.4-beta.2
0.0.4-beta.1
0.0.4-alpha.9
0.0.4-alpha.8
0.0.4-alpha.7
0.0.4-alpha.6
0.0.4-alpha.5
0.0.4-alpha.4
0.0.4-alpha.3
0.0.4-alpha.2
0.0.4-alpha.1
0.0.3
0.0.3-alpha.3
0.0.3-alpha.2
0.0.3-alpha.1
0.0.2
0.0.2-rc.2
0.0.2-rc.1
0.0.2-beta.4
0.0.2-beta.3
0.0.2-beta.2
0.0.2-beta.1
0.0.2-alpha.3
0.0.2-alpha.2
0.0.2-alpha.1
0.0.1
Mishka Chelekom is a fully featured components and UI kit library for Phoenix & Phoenix LiveView
Current section
Files
Jump to
Current section
Files
usage-rules/docs/getting-started.md
# Chelekom Phoenix UIKit - Getting Started Guide
## Overview
Chelekom is a zero-configuration component library for Phoenix development. Rather than installing complex dependencies, developers can add only needed components to their projects using mix tasks, keeping production builds lightweight.
The library's name has symbolic meaning: "Mishka" translates to "sparrow," while "Chelekom" refers to "neatly arranged cut logs."
## Installation Steps
### Step 1: Add to Dependencies
Update your `mix.exs` file to include:
```elixir
def deps do
[
{:mishka_chelekom, "~> 0.0.9", only: :dev}
]
end
```
### Step 2: Generate Components
Generate individual components with customization options:
```bash
mix mishka.ui.gen.component alert
mix mishka.ui.gen.component alert --color info --variant default
```
Or install all components at once:
```bash
mix mishka.ui.gen.components
```
### Step 3: Import Configuration (Optional)
Generate components with automatic importing:
```bash
mix mishka.ui.gen.components --import --helpers --global --yes
```
## Quick Install
For immediate setup without manual configuration:
```bash
mix mishka.ui.gen.components --import --helpers --global --yes
```
## Key Features
- **Zero-configuration approach** - no setup beyond library installation
- **Development-only dependency** - completely removed from production builds
- **Customizable components** - configure colors, variants, and functionality
- **Mix task automation** - streamlined component generation
- **Helper functions included** - optional utility imports available
## Compatibility Requirements
- Elixir 1.17+
- Erlang/OTP 27+
- Tailwind 4+
- Phoenix 1.8+
- Phoenix LiveView 1.1+
## Next Steps
- [CLI Documentation](https://mishka.tools/chelekom/docs/cli) - Learn all mix commands
- [Design System](https://mishka.tools/chelekom/docs/design-system) - Understand the design principles
- [Component List](https://mishka.tools/chelekom/docs) - Browse all available components