Modular JavaScript framework for building scalable and reactive applications
Switch branches/tags
Clone or download
Latest commit b5ff9b8 Sep 11, 2018

README.md

frint

npm Build Status codecov NSP Status Join the chat at https://gitter.im/frintjs/frint Greenkeeper

The modular JavaScript framework

For documentation, visit https://frint.js.org.

Key characteristics and features include:

  • Gives your applications a structure
  • Environment agnostic (runs in browser, server, and CLI)
  • Rendering library agnostic (integrates with React, Vue, and Preact)
  • Composable with multiple packages as needed
  • Each package is focused on doing one thing only and doing it well
  • Modular architecture with Apps
  • Embraces reactive programming with RxJS
  • Progressive and easy to adopt in existing applications

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to frintjs-conduct@googlegroups.com.

Quick start

Install frint-cli:

$ npm install -g frint-cli

Initialize an example app:

$ frint new my-directory --example kitchensink

Now you can install all the dependencies, and start the application:

$ cd my-directory
$ npm install
$ npm start

Find more examples here.

Packages

The framework is a collection of these packages, which can be composed together on demand:

Package Status Description
frint frint-status Base for creating Apps
frint-store frint-store-status State management with reactive stores
frint-data frint-data-status Reactive data modelling
frint-react frint-react-status React.js integration
frint-react-server frint-react-server-status Server-side rendering of Apps
frint-router frint-router-status Router services for building Single Page Applications
frint-router-react frint-router-react-status React components for building SPAs
frint-cli frint-cli-status CLI runner
frint-model frint-model-status Use frint-data instead

For library developers

These packages enable you to create packages integrating FrintJS with other rendering libraries:

Internally used

Community projects

License

MIT © FrintJS Authors and Travix International