https://github.com/tinijs/tinijs

The TiniJS Framework 🥚
https://github.com/tinijs/tinijs

Last synced: about 2 months ago
JSON representation

The TiniJS Framework 🥚

• Host: GitHub
• URL: https://github.com/tinijs/tinijs
• Owner: tinijs
• License: mit
• Created: 2023-08-27T12:33:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-22T15:26:56.000Z (5 months ago)
• Last Synced: 2024-04-23T05:17:37.133Z (5 months ago)
• Language: TypeScript
• Homepage: https://tinijs.dev
• Size: 10.9 MB
• Stars: 78
• Watchers: 6
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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](https://lit.dev) and aims to provide a native, lightweight, interoperable platform for building web applications.

For more details and usage, please visit 

## Development

- Fork the repository

- Install the dependencies: `npm i`. Install new dependencies for a specific package: `npm i  -w @tinijs/`

- Format: `npm run fix`

- Lint: `npm run lint`

- Test: `npm run test`

- Build:

  - All: `npm run build`

  - Specific: `npm run build -- --scope @tinijs/`

## Release

The `npm run release` script does the following:

1. Release the main packages inside `./packages` using Lerna (**MUST** run first)

2. Release the `@tinijs/ui-*` packages inside `./packages/ui/build` using a custom script

### Prebuilt UI packages

Prebuilt UI packages are released using the `release-ui` script.

```bash

npx tsx ./scripts/release-ui.mts

```

| Option              | Description                                                            |

| ------------------- | ---------------------------------------------------------------------- |

| `--dir `      | The path to the UI build dir, default `./packages/ui/build`            |

| `--pick `    | Pick certain packages to release, provide dir names in comma-separated |

| `--version ` | 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 `version` field

  - The `dependencies, devDependencies` fields (if packages depend on each other)

- Release:

  - Normal packages: `cd packages/ && npm publish`

  - UI packages (if required): at the root, run `npx tsx ./scripts/release-ui.mts --version `

## License

**The TiniJS Framework** is released under the [MIT](./LICENSE) license.