README
Exalt Logo">
Exalt Logo">
Exalt is a JavaScript framework for developing websites, apps and component libraries. Exalt prioritizes bundle size and cross framework compatibilty by making use of Web Components. This means you can use Exalt components with your favorite libraries and frameworks.
According to webcomponents.dev Exalt ranks first place on bundle size when minified!
Documentation
- Installation
- Getting Started
- Ecosystem
- Core Documentation
- CLI Documentation
- Toolchain Documentation
- Supporting Development
Installation
Exalt is super easy to get up and running. First install the Exalt CLI globaly. This will give you access to the exalt commands that help you create and develop your project.
To install the Exalt CLI, run the following command:
npm install -g @exalt/cli
When the Exalt CLI is used outside a project, it can only generate projects but when used inside a project folder, it can load the specified toolchain and power the development commands. This allows the cli to be used regardless of build requirements. If the default toolchain does not fit your needs you can create your own.
If you are using VSCode, you can get a better development experience by using the Exalt VSCode Extension. This extension provides support for syntax highlighting, auto completion, and intellisense for exalt templates.
Getting Started
Create a new Project
You can create a new project by running the create command and supplying the project name. This will generate your new project, install the required dependencies, and initialize a new git repository. By default @exalt/toolchain is used to power your projects build pipeline. This can be changed using the toolchain option in your exalt.json file.
exalt create <app-name>
Run The Application
While using the default toolchain, the dev command will launch a web server, watch your files, and build the app as you make changes. As soon as the initial build is complete it will open your app in your default web browser. Any builds after this will refresh the page.
# Navigate to the project folder
cd <app-name>
# Launch the development server
exalt dev
Ecosystem
| Project | Description |
|---|---|
| @exalt/core | Core Framework |
| @exalt/cli | Framework CLI |
| @exalt/toolchain | Toolchain for JavaScript and TypeScript development |
| @exalt/router | A simple client side router for exalt apps |
| @exalt/ssr | A module to render web components on the server |
Supporting Development
Exalt is licensed under MIT and is developed during the authors free time.
If you are interested in supporting the project financially, You can sponsor the project on Patreon or PayPal
Reporting Issues
If you are having trouble getting something to work with exalt or run into any problems, you can create a new issue.
If this framework does not fit your needs or is missing a feature you would like to see, let us know! We would greatly appreciate your feedback on it.
License
Exalt is licensed under the terms of the MIT license.