Go to file

ClarkXia 7969e92995 fix: alias in mode vite (#4890 )		2021-11-12 17:36:37 +08:00
.github	feat: upgrade swc deps and add test case (#4849 ) (#4881 )	2021-11-09 10:52:11 +08:00
examples	fix: ssr not works in promissory routes (#4874 )	2021-11-09 11:04:04 +08:00
packages	fix: alias in mode vite (#4890 )	2021-11-12 17:36:37 +08:00
scripts	feat: bundle swc (#4645 )	2021-09-23 14:03:34 +08:00
test	Fix: can run project normally when first use store (#4708 )	2021-10-20 14:55:16 +08:00
.commitlintrc.js	…
.editorconfig	feat: upgrade swc deps and add test case (#4849 ) (#4881 )	2021-11-09 10:52:11 +08:00
.eslintignore	chore: remove rax packages	2020-11-17 15:15:00 +08:00
.eslintrc.js	fix: refactor eslint config (#4751 )	2021-10-20 14:21:09 +08:00
.gitignore	feat: bundle swc (#4645 )	2021-09-23 14:03:34 +08:00
CHANGELOG.md	chore: changelog (#4070 )	2021-01-28 17:39:06 +08:00
LICENSE	…
README.md	docs(README): update contributors	2021-11-02 18:34:23 +08:00
README_zh-CN.md	docs: optimize readme (#4403 )	2021-06-24 17:23:48 +08:00
babel.config.js	fix: test case for request	2021-09-17 13:47:22 +08:00
codecov.yml	Feat/enhance useRequest (#3243 )	2020-06-08 09:49:38 +08:00
jest.config.js	fix: test case for request	2021-09-17 13:47:22 +08:00
lerna.json	chore: update version (#3411 )	2020-08-10 16:22:43 +08:00
package.json	Fix: can run project normally when first use store (#4708 )	2021-10-20 14:55:16 +08:00
tsconfig.json	feat: 🎸 support jsx-plus in vite mode (#4825 )	2021-11-04 15:19:53 +08:00
tsconfig.settings.json	feat: enhance debug package (#4505 )	2021-07-28 16:47:11 +08:00
yarn.lock	Merge branch 'release/2.2.0' of github.com:alibaba/ice into release/2.2.0	2021-11-10 15:58:21 +08:00

README.md

English | 简体中文

icejs

A universal framework based on React.js, Docs.

Features

🐒 Engineering：Out of the box support for ES6+、TypeScript、Less、Sass、 CSS Modules，etc
🦊 Routing：Powerful Routing System, supports configured routing and conventions routing
🐯 State management：Built-in icestore, lightweight state management solution based on React Hooks
🐦 Config：Modes and Environment Variables configuration in the config file
🐶 Logger：Built-in logger solution, it's a flexible abstraction over using console.log as well
🦁 Application configuration：Provide powerful and extensible application configuration
🐴 Hooks：Provide Hooks APIs such as useModel and useHistory, etc
🐌 Plugin system：The plugin system provides rich features and allow the community to build reusable solutions
🐘 TypeScript：Support TypeScript
🐂 Modern：Support SPA、SSR、MPA and Micro-frontend

Quick start

Setup by VS Code

We recommend creating a new icejs app using AppWorks:

See Quick start by AppWorks for more details.

Setup by CLI

We recommend creating a new icejs app using create-ice, which sets up everything automatically for you. To create a project, run:

$ npm init ice <project-name>

npm init <initializer> is available in npm 6+

Start local server to launch project:

$ cd <project-name>
$ npm install
$ npm run start # running on http://localhost:3333.

It's as simple as that!

Examples

Contributing

Please see our CONTRIBUTING.md

Contributors

_chenbin92	_ClarkXia	_狒狒神	_{Hengchang Lu}	_大果	_NK	_那吒	_yangfan	_Rhuzerv	_f00bar
_许文涛	_sspku-yqLiu	_{Jesse Feng}	_MO	_chenliandong	_sprying	_0xflotus	_AshShen	_{Eric Zhang}	_{Far Tseng}
_QYW	_Art.XD	_Yurisa	_{ZHOU Cheng}	_游鹿	_nancy	_nieyao	_truman.p.du	_dadalong	_yanchanglu
_二凢	_木杉	_炽翎	_蒋启钲	_赵的拇指	_赵锐

Ecosystem

Project	Docs	Description
icejs	docs	A universal framework based on react.js
icestark	docs	Micro Frontends solution for large application
icestore	docs	Simple and friendly state for React
formily	docs	Performant, flexible and extensible form solution
ahooks	docs	React Hooks Library