https://github.com/indios/trebor
A node js module to make standalone web components.
https://github.com/indios/trebor
cli no-framework reactive-programming single-file-component standalone-components trebor web-components webpack
Last synced: 18 days ago
JSON representation
A node js module to make standalone web components.
- Host: GitHub
- URL: https://github.com/indios/trebor
- Owner: InDIOS
- License: mit
- Created: 2018-03-05T20:38:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T20:56:18.000Z (about 2 years ago)
- Last Synced: 2025-04-22T14:57:33.162Z (about 1 month ago)
- Topics: cli, no-framework, reactive-programming, single-file-component, standalone-components, trebor, web-components, webpack
- Language: TypeScript
- Homepage:
- Size: 1.37 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# trebor
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Release][github-img]][github-url]
[![Build Status][travis-image]][travis-url]
### Overview
[TreborJS](https://npmjs.org/package/trebor) is a [NodeJS](http://nodejs.org) module to compile `component declarated files` into `stand-alone web component` javascript files to be used
in the browser. The format of a [single file component](https://github.com/InDIOS/trebor/wiki/Component-declaration) is specified be the module and described
in it's [documentation](https://github.com/InDIOS/trebor/wiki).
### Why?
In this days front-end frameworks are very populars comming to be an important part of a web application. Almost all of then have a runtime library that is part of the application, [Vue](https://github.com/vuejs/vue), [React](https://github.com/facebook/react), [Angular](https://github.com/angular/angular), but what if we can make a component that no need a runtime lib?
What if we can create all components without useless code and can run it self?. That is what `TreborJS` do, a module that compile an structured html file in a javascript file with just the code you need and nothing more.
## How to use
Install locally
```bash
npm i trebor -D
```
or install globally
```bash
npm i trebor -g
```
## Documentation
Read the documentation [here](https://github.com/InDIOS/trebor/wiki)
## Contributions
>TO-DO
## License
[MIT](https://github.com/InDIOS/trebor/blob/master/LICENSE)
[npm-image]: https://img.shields.io/npm/v/trebor.svg
[npm-url]: https://npmjs.org/package/trebor
[downloads-image]: https://img.shields.io/npm/dm/trebor.svg
[downloads-url]: https://npmjs.org/package/trebor
[github-img]: https://img.shields.io/github/release/InDIOS/trebor.svg
[github-url]: https://github.com/InDIOS/trebor/releases/latest
[travis-image]: https://img.shields.io/travis/InDIOS/trebor/master.svg?label=build
[travis-url]: https://travis-ci.org/InDIOS/trebor