Overview
The TiniJS Framework is a meta-framework designed to assist in building web applications using tools based on Lit. It offers a lightweight and interoperable platform for developing web applications. For further details and usage instructions, refer to the development instructions provided.
Features
- Collection of Tools: TiniJS Framework offers a comprehensive collection of tools for building web applications.
- Based on Lit: The framework is built on Lit, providing a native platform for web development.
- Interoperable Platform: It aims to provide a platform that is interoperable with other web application development tools.
- Development Scripts: Includes various npm scripts for development tasks such as fixing, linting, testing, and building applications.
- Release Management: Provides a script for releasing main packages and UI packages using Lerna and a custom script, respectively.
- Prebuilt UI Packages: Support for releasing prebuilt UI packages with options for specifying directories and versions.
- Individual Release: Allows for individual release of packages for small changes or hotfixes.
- License: The TiniJS Framework is released under the MIT license.
Installation
- Fork the repository.
- Install dependencies:
npm i
. - Install new dependencies for a specific package:
npm i <name> -w @tinijs/<package-name>
. - Format code:
npm run fix
. - Lint code:
npm run lint
. - Test code:
npm run test
. - Build:
- All:
npm run build
. - Specific package:
npm run build -- --scope @tinijs/<package-name>
.
- All:
Summary
The TiniJS Framework is a meta-framework that provides a set of tools for building web applications based on Lit. It offers a lightweight and interoperable platform, development scripts for various tasks, release management scripts, support for prebuilt UI packages, and individual release options. Additionally, it is released under the MIT license, making it an accessible and flexible framework for web developers.