# egg-react-typescript-boilerplate

> 基于 egg + react + typescript + webpack 服务端渲染工程骨架项目

Latest version **5.1.2** (published 2024-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-react-typescript-boilerplate
pnpm add egg-react-typescript-boilerplate
yarn add egg-react-typescript-boilerplate
bun add egg-react-typescript-boilerplate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.1.2 |
| Published | 2024-09-08 |
| First published | 2018-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 28 |
| Unpacked size | 567.6 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 57 |
| Author | hubcarl@126.com |
| Maintainers | hubcarl |

## Links

- npm: https://www.npmjs.com/package/egg-react-typescript-boilerplate
- Repository: https://github.com/easy-team/egg-react-typescript-boilerplate
- Issues: https://github.com/easy-team/egg-react-typescript-boilerplate/issues
- npm.io page: https://npm.io/package/egg-react-typescript-boilerplate

## Dependencies (28)

- [mo](https://npm.io/package/mo.md) ^1.7.3
- [egg](https://npm.io/package/egg.md) ^2.1.0
- [mobx](https://npm.io/package/mobx.md) ^6.1.6
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [react](https://npm.io/package/react.md) 17.0.1
- [redux](https://npm.io/package/redux.md) 4.0.5
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [moment](https://npm.io/package/moment.md) ^2.17.1
- [shortid](https://npm.io/package/shortid.md) ^2.2.8
- [egg-cors](https://npm.io/package/egg-cors.md) ^2.0.0
- [showdown](https://npm.io/package/showdown.md) ^1.8.6
- [cross-env](https://npm.io/package/cross-env.md) ^7.0.3
- [lodash-id](https://npm.io/package/lodash-id.md) ^0.14.0
- [react-dom](https://npm.io/package/react-dom.md) 17.0.1
- [egg-logger](https://npm.io/package/egg-logger.md) ^2.5.0
- [mobx-react](https://npm.io/package/mobx-react.md) 7.1.0
- [egg-scripts](https://npm.io/package/egg-scripts.md) ^2.6.0
- [react-redux](https://npm.io/package/react-redux.md) 7.2.2
- [egg-validate](https://npm.io/package/egg-validate.md) ^2.0.2
- [react-router](https://npm.io/package/react-router.md) 5.2.0
- [react-loadable](https://npm.io/package/react-loadable.md) ^5.5.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) 5.2.0
- [egg-view-react-ssr](https://npm.io/package/egg-view-react-ssr.md) ^3.0.0
- [react-router-redux](https://npm.io/package/react-router-redux.md) ^4.0.8
- [react-router-config](https://npm.io/package/react-router-config.md) 5.1.1
- [conventional-changelog-cli](https://npm.io/package/conventional-changelog-cli.md) ^1.3.5
- [@hubcarl/json-typescript-mapper](https://npm.io/package/@hubcarl/json-typescript-mapper.md) ^2.0.1

## Recent versions

- 5.1.2 (latest) — 2024-09-08
- 5.1.0 — 2023-04-01
- 4.1.5 — 2020-05-23
- 4.1.3 — 2020-05-17
- 4.1.2 — 2020-01-30
- 4.1.1 — 2020-01-29
- 4.1.0 — 2020-01-29
- 4.0.0 — 2020-01-03
- 3.2.0 — 2019-08-02
- 3.0.2 — 2019-07-25
- 3.0.1 — 2018-11-13
- 3.0.0 — 2018-11-08
- 2.3.0 — 2018-11-07
- 2.2.0 — 2018-10-22
- 2.1.0 — 2018-07-23
- … 5 more at https://npm.io/package/egg-react-typescript-boilerplate/versions

## README

# egg-react-typescript-boilerplate

基于 Egg + React + TypeScript + Webpack 服务端渲染工程骨架

## 版本

- Egg 版本： ^2.x.x
- Node 版本: Node ^8.x.x+,
- Webpack 版本: ^4.x.x
- React 版本: ^16.0.0
- TypeScript: ^3.0.0

## 文档

- https://easyjs.cn/egg-react
- https://www.yuque.com/easy-team/egg-react


## 特性

- 支持 Egg Node 端代码和前端代码 TypeScript 编写和构建

- 支持 Node 和 asyncData 方式获取数据进行渲染

- 支持多页面(MPA) 和 单页面(SPA) 服务端渲染(SSR)和前端渲染(CSR)

- 支持 AntD 按需加载和主题配置功能以及 MobX 应用

- 支持 Webpack 时时编译和热更新, `npm run dev` 一键启动应用

- 支持开发环境, 测试环境，正式环境 Webpack 编译
 

## 依赖

- [easywebpack-react](https://github.com/hubcarl/easywebpack)
- [egg-view-react-ssr](https://github.com/hubcarl/egg-view-react-ssr) 
- [egg-webpack](https://github.com/hubcarl/egg-webpack) 
- [egg-webpack-react](https://github.com/hubcarl/egg-webpack-react)

## 运行

#### 安装依赖

```bash
npm install
```

#### 本地启动应用

```bash
npm run dev
```

应用访问: http://127.0.0.1:7001

#### 构建文件

- TypeScript Egg 构建

```bash
npm run tsc
```

- TypeScript 前端工程构建

```bash
npm run build
```

#### 打包部署

1. 先运行 `npm run tsc` 和 `npm run build` 构建 TypeScript Egg 代码和 TypeScript 前端代码
2. 项目代码和构建代码一起打包代码
3. 应用部署后，通过 `npm start` 启动应用


## 开发

#### 编写前端代码

>添加 `${root}/app/web/page/demo.tsx` 前端代码

```js
'use strict';
import React, { Component } from 'react';
class Demo extends Component<any, any> {
  render() {
    const { title, article } = this.props;
    return <div>
      <h1 className="easy-article-detail-title">{title}</h1>
      <h3 className="easy-article-detail-title">{article.title}</h3>
      <div>{article.content}</div>
    </div>;
  }
}
export default Demo;
```

#### 编写 Node 代码

>添加 `${root}/app/controller/demo.ts` Node 代码

```js
import { Controller, Context } from 'egg';

export default class DemoController extends Controller {
  public async index(ctx: Context) {
    const title = 'Node 直接获取渲染数据';
    const article = await ctx.service.article.query({ id: Number(id) });
    await ctx.render('demo.js', { title, article });
  }
}
```

#### Egg 路由配置 

>添加 `${root}/app/router.ts` Egg 路由配置

```js
import { Application } from 'egg';
export default (app: Application) => {
  const { router, controller } = app;
  router.get('/demo', controller.demo.index);
};
```

#### Webpack 构建配置

>添加 `${root}/webpack.config.js` 新增页面 entry 配置

```js
module.exports = {
  entry: {
    demo: 'app/web/page/demo.tsx',
  }
}
```


## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-react-typescript-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
