TiniJS Framework
The TiniJS Framework (meta-framework) is a collection of tools for building web applications from start to finish. It is based on Lit and aims to provide a native, lightweight, interoperable platform for building web applications.
For more details and usage, please visit https://tinijs.dev
Development
- Fork the repository
- Install the dependencies:
npm i. Install new dependencies for a specific package:npm i <name> -w @tinijs/<package-name> - Format:
npm run fix - Lint:
npm run lint - Test:
npm run test - Build:
- All:
npm run build - Specific:
npm run build -- --scope @tinijs/<package-name>
- All:
Release
The npm run release script does the following:
- Release the main packages inside
./packagesusing Lerna (MUST run first) - Release the
@tinijs/ui-*packages inside./packages/ui/buildusing a custom script
Prebuilt UI packages
Prebuilt UI packages are released using the release-ui script.
npx tsx ./scripts/release-ui.mts| Option | Description |
|---|---|
--dir <path> |
The path to the UI build dir, default ./packages/ui/build |
--pick <names> |
Pick certain packages to release, provide dir names in comma-separated |
--version <value> |
Provide a version, default to field version in lerna.json |
Individual release
In case of small changes and hotfixes, packages can be released individually.
- Manually update
package.json:- The
versionfield - The
dependencies, devDependenciesfields (if packages depend on each other)
- The
- Release:
- Normal packages:
cd packages/<name> && npm publish - UI packages (if required): at the root, run
npx tsx ./scripts/release-ui.mts --version <version>
- Normal packages:
License
The TiniJS Framework is released under the MIT license.