飞冰(ICE)

简单而友好的前端研发体系。海量可复用物料,搭配研发套件极速构建前端应用。

相关关键字: 前端 飞冰 淘系技术

A universal framework based on React.js

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

  • 🐱

     Helpers:Built-in helpers, provide some useful utility functions

  • 🦁

     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 AppWorks

We recommend creating a new icejs app using AppWorks:

demo

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!

Manual Setup

icejs is really easy to get started with. Install ice.jsreact and react-dom in your project:

$ mkdir <project-name> && cd <project-name>$ npm install ice.js react react-dom

Open package.json and add the following scripts:

{  "name": "project-name",  "scripts": {    "start": "icejs start",    "build": "icejs build"
  },  "dependencies": {    "ice.js": "^1.0.0",    "react": "^16.12.0",    "react-dom": "^16.12.0"
  }
}

Create the pages directory, then create the first page in pages/index.jsx:

import React from 'react'const HomePage = () => {
  return <div>Welcome to icejs!</div>}export default HomePage

Configure an application information in the src/app.js file, but it is optional:

import { runApp } from 'ice'const appConfig = {
  router: {
    type: 'browser',
  },

  // more...}runApp(appConfig)

Finally, To start developing your application run npm run start. The application is now running on http://localhost:3333.

Examples

Contributing

Please see our CONTRIBUTING.md

Ecosystem

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

Community

GitHub issues Gitter
issues gitter

License

MIT


相关技术 浏览更多
相关视频 浏览更多