Skip to content

Commit

Permalink
docs(website): update
Browse files Browse the repository at this point in the history
  • Loading branch information
unadlib committed Dec 22, 2024
1 parent 49b69a1 commit 56072bb
Show file tree
Hide file tree
Showing 149 changed files with 1,028 additions and 24,808 deletions.
1 change: 0 additions & 1 deletion docs/apis/.nojekyll

This file was deleted.

139 changes: 139 additions & 0 deletions docs/apis/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,140 @@
**Documentation**

***

<a href="https://reactant.js.org/" target="_blank"><img src="https://raw.githubusercontent.com/unadlib/reactant/master/logo.svg" height="120" alt="Reactant Logo" /></a>

---

![Node CI](https://github.com/unadlib/reactant/workflows/Node%20CI/badge.svg)
[![npm version](https://badge.fury.io/js/reactant.svg)](http://badge.fury.io/js/reactant)
![license](https://img.shields.io/npm/l/reactant)

Reactant - A framework for building React applications

## Motivation

React is a JavaScript library for building user interfaces, but when we want to develop applications based on React, we often have to do a lot of building configuration and many other libraries choices(Picking and learning a React state library and router library, etc.). We also need to consider how our business logic should be abstracted and structured. Everyone who uses React practices their own perception of how React is built, but it doesn't allow us to quickly focus on the business logic itself. As the application business grows in size, we urgently need a framework that can be easily understood and maintained.

And for the structured design of the application's business logic, separation of concern is a good idea. It requires clear boundaries of liability to avoid low maintainability when UI logic and business logic are mixed. We always want to focus on business logic when building applications. It is one of the business core values of an application. We want it to be easy to maintain, and test. Redux remains most popular state library in React. It is fully accord with immutable principles for React. Redux is just a state container, and we're often at a loss for how to really manage those states. We need a framework for scalable, loosely coupled and easily maintainable React applications.

---

**In order to solve these problems, Reactant was created. It's a framework for React.**

## Features

- Dependency injection
- Immutable state management
- View module
- Redux plug-in module
- Test bed for unit testing and integration testing
- Routing module
- Persistence module
- Module dynamics
- [reactant-share - Shared web app support multiple browser windows](https://github.com/unadlib/reactant/tree/master/packages/reactant-share)
- Shared tab
- SharedWorker
- Detached window
- iframe
- Server-side Rendering

## Q&A

1. How does it differ from Angular?

It is different everywhere except for dependency injection.

2. What is the biggest advantage of Reactant?

It can architect a variety of large React projects. Reactant advocates a lightweight UI, separating the concerns of the application and UI to greatly enhance the maintainability of the project.

## Usage

```bash
npx reactant-cli init my-app
cd my-app
yarn start
```

## Example

* [TodoMVC](https://stackblitz.com/edit/reactant-todomvc)

---

Reactant is very easy to get started. You can try Reactant by visiting the [online demo](https://stackblitz.com/edit/reactant-ts).

Here is the counter example:

```tsx
import React from 'react';
import { ViewModule, createApp, injectable, useConnector, action, state } from 'reactant';
import { render } from 'reactant-web';

@injectable()
class Counter {
@state
count = 0;

@action
increase() {
this.count += 1;
}
}

@injectable()
class AppView extends ViewModule {
constructor(public counter: Counter) {
super();
}

component() {
const count = useConnector(() => this.counter.count);
return (
<button type="button" onClick={() => this.counter.increase()}>
{count}
</button>
);
}
}

const app = createApp({
main: AppView,
render,
});

app.bootstrap(document.getElementById('app'));
```

## Packages
- reactant
- reactant-cli
- reactant-di
- reactant-last-action
- reactant-model
- reactant-module
- reactant-native
- reactant-redux
- reactant-router
- reactant-router-dom
- reactant-router-native
- reactant-share
- reactant-ssr
- reactant-storage
- reactant-template
- reactant-web

## Documentation

* [Getting Started](https://reactant.js.org/docs/intro)
* [Tutorial](https://reactant.js.org/docs/category/basic-tutorial)
* [Concepts](https://reactant.js.org/docs/getting-started/concepts)
* [Advanced Guides](https://reactant.js.org/docs/category/advanced-guides)
* [API Reference](https://reactant.js.org/docs/api/reactant/modules/createApp)

You can visit [reactant.js.org](https://reactant.js.org/) for more documentation.

## License

Reactant is [MIT licensed](https://github.com/unadlib/reactant/blob/master/LICENSE).
Binary file added docs/apis/_media/workflow.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 0 additions & 37 deletions docs/apis/classes/reactant.ModuleRef.md

This file was deleted.

59 changes: 0 additions & 59 deletions docs/apis/classes/reactant.Optional.md

This file was deleted.

Loading

0 comments on commit 56072bb

Please sign in to comment.