/lib__pico-ts

Pico-TS is a tiny ui library for the web without any 3rd party dependency.

BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Pico-TS

Pico-TS is a tiny ui library without any 3rd party dependency.

[!WARNING] Please note that the library is currently under active development and not yet stable. It may have breaking changes or incomplete functionality. Strongly recommended using it only for experimental purposes and not in production environments!!

Key Features

  • Tiny: Tiny size, making it an ideal choice for developers looking to minimize their project's footprint.
  • TypeScript: Pre-configured TypeScript setup for strict type checking and optimal developer experience.
  • SonarLint & Prettier: Integrated code analysis and formatting tools to maintain code quality and consistency.
  • Node.js Testing: Integrated Node.js testing utilities for writing comprehensive and reliable unit tests.

Getting Started

Prerequisites

  • Node.js 20.9 or higher
  • NPM 10.2.4 or higher

Development Setup and Usage

  1. Local setup:
    • Clone this repository to your machine.
    • Navigate to the repository folder in your terminal.
    • Run npm install to install all development dependencies.
  2. Development workflow:
    • npm run build - Compiles the TypeScript code.
    • npm run test - Runs unit tests to ensure code reliability.
    • npm run sonar - Performs code analysis for potential issues.
    • npm run format - Formats the code using Prettier.
    • npm run clean - Clears the build directory.

License

This project is licensed under the BSD-3-Clause.