https://github.com/chenbin92/shitu
ionic App
https://github.com/chenbin92/shitu
Last synced: about 1 year ago
JSON representation
ionic App
- Host: GitHub
- URL: https://github.com/chenbin92/shitu
- Owner: chenbin92
- License: mit
- Created: 2015-07-19T08:49:20.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T04:53:07.000Z (over 3 years ago)
- Last Synced: 2025-05-14T09:17:12.779Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
English | [简体中文](./README_zh-CN.md)
> 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
We recommend creating a new icejs app using create-ice, which sets up everything automatically for you. To create a project, run:
```bash
$ npm init ice
```
`npm init ` is available in npm 6+
Start local server to launch project:
```bash
$ cd
$ 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.js`, `react` and `react-dom` in your project:
```bash
$ mkdir && cd
$ npm install ice.js react react-dom
```
Open `package.json` and add the following scripts:
```json
{
"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`:
```jsx
import React from 'react'
const HomePage = () => {
return
Welcome to icejs!
}
export default HomePage
```
Configure an application information in the `src/app.js` file, but it is optional:
```js
import { createApp } from 'ice'
const appConfig = {
router: {
type: 'browser',
},
// more...
}
createApp(appConfig)
```
Finally, To start developing your application run `npm run start`. The application is now running on [http://localhost:3333](http://localhost:3333).
## Examples
- [hello-world](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/hello-world)
- [basic-spa](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/basic-spa)
- [basic-ssr](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/basic-ssr)
- [basic-mpa](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/basic-mpa)
- [basic-store](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/basic-store)
- [basic-request](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/basic-request)
- [icestark-child](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/icestark-child)
- [icestark-layout](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/icestark-layout)
- [with-fusion-design](https://codesandbox.io/s/github/ice-lab/icejs/tree/master/examples/with-fusion-design)
## Contributing
Please see our [CONTRIBUTING.md](/.github/CONTRIBUTING.md)
## Ecosystem
| Project | Version | Docs | Description |
|----------------|-----------------------------------------|--------------|-----------|
| [icejs] | [![icejs-status]][icejs-package] | [docs][icejs-docs] |A universal framework based on react.js|
| [iceworks] | [![iceworks-cli-status]][iceworks-cli-package] | [docs][iceworks-docs] |One-stop visual source code development workbench based on materials|
| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] |Micro Frontends solution for large application|
| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] |Lightweight state management solution based on React Hooks|
[icejs]: https://github.com/ice-lab/icejs
[iceworks]: https://github.com/alibaba/ice
[icestark]: https://github.com/ice-lab/icestark
[icestore]: https://github.com/ice-lab/icestore
[icejs-status]: https://img.shields.io/npm/v/ice.js.svg
[iceworks-cli-status]: https://img.shields.io/npm/v/iceworks.svg
[icestark-status]: https://img.shields.io/npm/v/@ice/stark.svg
[icestore-status]: https://img.shields.io/npm/v/@ice/store.svg
[icejs-package]: https://npmjs.com/package/ice.js
[iceworks-cli-package]: https://npmjs.com/package/iceworks
[icestark-package]: https://npmjs.com/package/@ice/stark
[icestore-package]: https://npmjs.com/package/@ice/store
[icejs-docs]: https://ice.work/docs/guide/intro
[iceworks-docs]: https://ice.work/docs/iceworks/about
[icestark-docs]: https://ice.work/docs/icestark/guide/about
[icestore-docs]: https://github.com/ice-lab/icestore#icestore
## Community
| DingTalk community | GitHub issues | Gitter |
|-------------------------------------|--------------|---------|
| 
| [issues] | [gitter]|
[issues]: https://github.com/alibaba/ice/issues
[gitter]: https://gitter.im/alibaba/ice
## License
[MIT](/LICENSE)