tram-one8.0.0-beta.5 • Public • Published
Batteries Included View Framework
Installation, Docs, and API
You can visit the website tram-one.io to read installation instructions, feature documentation, and the complete API.
Tram-One is a view framework for developers who want to jump straight into building on the web. At its core, Tram-One is a collection of a few packages that gives you the tools to start working right away. That is to say... Batteries Included!
Tram-One is a project built to make exposing custom elements easy, and to have redux-like state management, and basic routing by default. It was created out of the frustration of having to scaffold the same dependencies over and over again.
Tram-One was also created to avoid a lot of the syntax that locks you into frameworks like Vue and React. The components written here can mimic the syntax you're already familiar, or help you create pure HTML friendly code.
This Repo and the Tram-One Org
This repo contains the main Tram-One framework, which can be installed and used to make web-apps. The Tram-One org (found at https://github.com/Tram-One) includes many of the dependencies as well as the websites for the project. The dependencies, while made for Tram-One, can be used in other projects.
If you want to start contributing, need help, or would just like to say hi, join our slack channel!
If you decide to clone this repo, there are several commands included in the
package.json to help you develop.
npm run lint, runs eslint in the project
npm run example, kicks off one of the example apps in this repo
npm run build, builds the project and creates a distributable
npm run test-dev, hosts the tests to be launched in a browser
npm run test, runs tests against all available browsers on the machine
Check out our Issues on Github. PRs welcome!