···11+MIT License Copyright (c) 2025 flo-bit
22+33+Permission is hereby granted, free of
44+charge, to any person obtaining a copy of this software and associated
55+documentation files (the "Software"), to deal in the Software without
66+restriction, including without limitation the rights to use, copy, modify, merge,
77+publish, distribute, sublicense, and/or sell copies of the Software, and to
88+permit persons to whom the Software is furnished to do so, subject to the
99+following conditions:
1010+1111+The above copyright notice and this permission notice
1212+(including the next paragraph) shall be included in all copies or substantial
1313+portions of the Software.
1414+1515+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
1616+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1717+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
1818+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
1919+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
2020+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121+THE SOFTWARE.
+80-1
README.md
···11-# fuchs ui11+# 🦊 fox ui
22+33+> **This is a public alpha release. Expect bugs and breaking changes.**
44+55+svelte v5 + tailwind v4
66+77+[See all components here](https://flo-bit.dev/ui-kit)
88+99+Read more about [the philosophy/aim of this project here](https://flo-bit.dev/ui-kit/docs/philosophy).
1010+1111+## Quickstart
1212+1313+### 1. Create a new svelte project with tailwind css (including `@tailwindcss/typography` and `@tailwindcss/forms` plugins)
1414+1515+```bash
1616+npx sv create my-project
1717+```
1818+1919+### 2. Install fuchs
2020+2121+```bash
2222+npm install fuchs
2323+```
2424+2525+### 3. set theme variables in your app.css (changing `zinc` and `emerald` to your preferred colors, using find and replace).
2626+2727+```css
2828+@source "../node_modules/fuchs";
2929+3030+@theme {
3131+ --color-base-50: var(--color-zinc-50);
3232+ --color-base-100: var(--color-zinc-100);
3333+ --color-base-200: var(--color-zinc-200);
3434+ --color-base-300: var(--color-zinc-300);
3535+ --color-base-400: var(--color-zinc-400);
3636+ --color-base-500: var(--color-zinc-500);
3737+ --color-base-600: var(--color-zinc-600);
3838+ --color-base-700: var(--color-zinc-700);
3939+ --color-base-800: var(--color-zinc-800);
4040+ --color-base-900: var(--color-zinc-900);
4141+ --color-base-950: var(--color-zinc-950);
4242+4343+ --color-accent-50: var(--color-emerald-50);
4444+ --color-accent-100: var(--color-emerald-100);
4545+ --color-accent-200: var(--color-emerald-200);
4646+ --color-accent-300: var(--color-emerald-300);
4747+ --color-accent-400: var(--color-emerald-400);
4848+ --color-accent-500: var(--color-emerald-500);
4949+ --color-accent-600: var(--color-emerald-600);
5050+ --color-accent-700: var(--color-emerald-700);
5151+ --color-accent-800: var(--color-emerald-800);
5252+ --color-accent-900: var(--color-emerald-900);
5353+ --color-accent-950: var(--color-emerald-950);
5454+}
5555+```
5656+5757+### 4. Use the components
5858+5959+```svelte
6060+<script>
6161+ import { Button } from 'fuchs';
6262+</script>
6363+6464+<Button onclick={() => alert('clicked')}>Click me</Button>
6565+```
6666+6767+## Development
6868+6969+If you want to contribute to the project, please open an issue first describing the feature you want to add.
7070+7171+Clone the repo, install dependencies and run the dev server
7272+7373+```bash
7474+git clone https://github.com/flo-bit/ui-kit.git
7575+cd ui-kit
7676+npm install
7777+npm run dev
7878+```
7979+8080+The ui-kit library is located in `src/lib`, the documentation is in `src/docs`.