Skip to content
/ xeito Public

🤞 Xeito is a framework for building interactive web applications with Typescript and Tagged Template Literals.

License

Notifications You must be signed in to change notification settings

xeitojs/xeito

Repository files navigation

Xeito

xeito-logo

Harness the power of the web.

Typescript framework for building web applications.

www.xeito.dev

Xeito on npm   License   Project Status   PRs welcome!  


📦 Components | ⚡ Reactive | 🗺️ Routing | 💉 Dependency Injection | 🔌 Extensible

Description

Xeito is a framework for building efficient, scalable web applications using Typescript. It combines some of the best features of Angular, Vue, React and Svelte to provide you with amazing tools to build your next web application. Combining elements of Object Oriented Programming, Functional Programming and Reactive Programming, Xeito provides a unique development experience that is both powerful and easy to use.

Xeito doesn't try to reinvent the wheel, but rather provide a set of tools that can be used to build applications in a way that is familiar to developers. It is built on top of the Web Components standard, adding the necessary abstractions and handling the boilerplate and complexity of the underlying technology.

Please bear in mind that, while Xeito components are ultimately registered as custom elements, these are not designed to work outside of the Xeito runtime.

Under the hood, Xeito makes use of µhtml to handle DOM updates and the template system, providing a VirtualDOM-less implementation with all of the advantages of more traditional JSX-based templates. With a small footprint, Xeito also has a Reactive Store system very similar to svelte/store that can be used to share application state across components and services.

You can read more about these and many other features in the documentation website at xeito.dev.

Note: The framework is still in its early stages of development and is not yet ready for production use. However, you can try it out and give feedback on the Github Discussions

Getting Started

It's recommended to start with the Quick Start guide to get a feel for the framework. Otherwise, you can follow the steps below to create a new project.

  • Install the Xeito CLI globally:
$ npm install -g @xeito/cli
  • Create a new project:
$ xeito new [PROJECT NAME]
  • Go to the project directory, install the dependencies and run the application:
$ cd [PROJECT NAME]
$ npm install
$ npm start

These commands will generate a brand new Xeito project with the default features, including Parcel for bundling, Sass for styling and Typescript as the main language.

If you want to jump straight into it, check the Introduction guide to get started.

Happy hacking! 🎉

Packages

Project Package Link Version
Core @xeito/core README.md npm version
Injection @xeito/injection README.md npm version
Router @xeito/router README.md npm version
Store @xeito/store README.md npm version
CLI @xeito/cli README.md npm version

All Xeito packages follow Semantic Versioning and their version numbers are synchronized.

Note: During the prerelease phase, the version number will be 0.x.x and the API may change between minor versions.

Contributing

Thanks for your interest in contributing! Please, read on the guidelines for contributing and then check the issues to see if there's anything you can help with.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Documentation

You can see the dedicated repository or view the live documentation site at xeito.dev.

Below you can find a list of the most important guides to get you started with Xeito.

Essentials

Reusability

Reactivity

Advanced

Stay in Touch

License

See the LICENSE file for license rights and limitations (MIT).