Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
gius committed May 30, 2020
1 parent e19fde6 commit 4068bd1
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You need Node.js and Yarn installed locally and run

```
yarn install
yarn lerna bootstrap
yarn lerna bootstrap --force-local
```

You can then check the environment with `yarn validate`, and if there are no errors, you should be good to go. You are now ready to contribute!
Expand Down
33 changes: 33 additions & 0 deletions OVERVIEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Frui.ts business overview

Nowadays, front-end applications are no longer just static websites with some JavaScript scripts used for simple validation or content animations - they are complex and business-critical applications that happened to run in a browser window. Therefore, front-end development requires the same effort in software architecture and quality control as any other part of the software solution.

We have built Frui.ts to bring development standards of backend or desktop applications to the dynamic field of HTML front-ends.

Frui.ts follows clean software architecture recommendations with a strong separation of concerns. Thus, the front-end application itself consists of multiple layers with clear responsibilities such as presentation layer, business logic layer, or data access layer. With that built-in the app from the beginning, our solutions are ready for long-term development and maintenance with no compromise of costs, initial setup, or development speed.

The presentation layer follows the Model-View-ViewModel pattern, which enables a clear distinction between the data and its actual visual representation. Two-way binding makes forms input, validation, and other data-related workflows implementation straightforward.

Our applications' inner structure follows the high-cohesion, loose coupling principle with dependency injection and message bus at its core.

The code is written in TypeScript, a modern, Microsoft-backed programming language with static typing, compile-time checks, and robust development tooling.

**Ultimate goals**
- Short- as well as long-term costs saving
- Adaptability to business needs and changes

**Core principles**
- mature application architecture
- separation of concerns
- inversion of control

**Core technologies**
- Typescript
- MVVM
- MobX
- React

**Benefits**
- Reliability
- Maintainability
- Extensibility
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ It allows **ViewModel-first** approach, which enables automated testing of compl

This framework is designed to support both small and large applications with SOLID codebase. It is built on top of the [React](https://reactjs.org/) library, using [MobX](https://mobx.js.org/) and written in the modern TypeScript language.

You can find business motivation and overview [here](OVERVIEW.md).

## Why should you use Frui.ts?

Because you can write this:
Expand Down

0 comments on commit 4068bd1

Please sign in to comment.