Skip to content

Commit

Permalink
Added link to the legacy documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gius committed Jul 19, 2022
1 parent e556636 commit cfdf1b7
Showing 1 changed file with 2 additions and 37 deletions.
39 changes: 2 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This framework is designed to support both small and large applications with SOL

> ## Jump to the [wiki](https://github.com/eManPrague/frui.ts/wiki) for detailed documentation.
> ## Looking for v0.x documentation? Check the [legacy](https://github.com/eManPrague/frui.ts/tree/legacy) branch.
---

# Why should you use Frui.ts?
Expand Down Expand Up @@ -87,40 +89,3 @@ const customerView: ViewComponent<CustomerViewModel> = observer(({ vm }) => (

registerView(customerView, CustomerViewModel);
```

# Modules

Frui.ts is a set of tools and helpers you can use to simplify your job. It consist of several packages that you can use **separately**. Togheter they creates MVVM framework for build frontend web applications with no pain.

## View models

The working or business logic layer. In this point is no matter what you use for render. We recommend to use React, but door are open to use other frameworks like Vue.

- [Screens](https://github.com/eManPrague/frui.ts/tree/develop/packages/screens/README.md) - components for application structure, navigation, etc. For example, `ScreenBase`, `ConductorSingleChild`, `Busywatcher`, `Router`.
- [Data Screens](https://github.com/eManPrague/frui.ts/tree/develop/packages/datascreens/README.md) - base classes for data-focused applications. For example, `FilteredListViewModel`, `DetailViewModel`.

## Views

- [Views](https://github.com/eManPrague/frui.ts/tree/develop/packages/views/README.md) - components for binding UI to ViewModels. For example, `BindingComponent`, `View`.
- [Data](https://github.com/eManPrague/frui.ts/tree/develop/packages/data/README.md) - helper functions for rendering sorted and filtered data. For example, `IPagingFilter`, `pageChangedHandler`, `setSort`.
- [Data Views](https://github.com/eManPrague/frui.ts/tree/develop/packages/dataviews/README.md) - higher-order components for displaying data. For example, `DataTable`, `DataRepeater`.

## Data

- [API client](https://github.com/eManPrague/frui.ts/tree/develop/packages/apiclient/README.md) - abstraction over network calls and fluent request builder. For example, `FetchApiConnector`, `RestRequestBuilder`.

## Validation

- [Validation](https://github.com/eManPrague/frui.ts/tree/develop/packages/validation/README.md) - standalone solution for MobX-based entity validation.
- [Dirty checking](https://github.com/eManPrague/frui.ts/tree/develop/packages/dirtycheck/README.md) - standalone solution for MobX-based dirty check flags.

## Helpers

- [CRA template](https://github.com/eManPrague/frui.ts/tree/develop/packages/cra-template/README.md) - Create React App template
- [Generator](https://github.com/eManPrague/frui.ts/tree/develop/packages/generator/README.md) - code generator for saving time in typical scenarios.
- [Helpers](https://github.com/eManPrague/frui.ts/tree/develop/packages/helpers/README.md) - shared helper functions used on various places in Frui.ts. For example, `@bound`, `createMap`, `nameof`.

## UI components

- [Bootstrap](https://github.com/eManPrague/frui.ts/tree/develop/packages/bootstrap/README.md) - UI components suporting two-way binding based on [React Bootstrap](https://react-bootstrap.github.io/), For example, `Input`, `Select`, `Check`, `ValidationControlBase`.
- [HTML controls](https://github.com/eManPrague/frui.ts/tree/develop/packages/htmlcontrols/README.md) - UI components suporting two-way binding based on plain HTML controls. For example, `Textbox`, `Checkbox`.

0 comments on commit cfdf1b7

Please sign in to comment.