leptodon 0.1.0

your Leptos UI toolkit for data science
Documentation

Leptodon

Your Leptos UI toolkit.

Getting started

  1. Use the template repository: //TODO: ... fill in
  2. Pick and place components from: https://leptodon.dev

Contributing

  1. Please enable the pre-commit hook for code styling.
  2. cargo make mimic-ci to locally test.

Dev-dependencies

A couple tools are required to work on this project:

  • cargo-make for the Makefile.toml
  • cargo-leptos for leptos
  • cargo-nextest for unit-tests
  • npm and playwright for end2end tests (There is a nix devenv in overview/end2end).
  • licensure for license header checks

Project layout

  • demo: leptos-ssr demo application, serves as developer-docs where they can preview demonstrations of leptodon's components.
    • overview/codegen: Generates a .tailwind file (containing all leptodon's source code for tailwind to generate css against).
  • proc-macros: Code-generation for the demo, see the demo README for more info on how this is used.
  • overview: leptos-ssr testing application, a suite of playwright tests is ran against this application, also serves as dev-zone for new components.
    • overview/end2end: The affordmentioned playwright tests.
    • overview/codegen: Generates both the .tailwind file (containing all leptodon's source code for tailwind to generate css against) as well as an IconList component.

Credits

  • ThawUI: component architecture inspiration + utilities [Copyright (c) 2023 lizidev]
  • Flowbite: general UI design [Copyright (c) Themesberg (Bergside Inc.)]