跳转至

本文章主要介绍readme的规范

国际化|English

项目工程介绍

  1. 仓库内容
  2. 环境配置
  3. 安装
  4. 使用
  5. 项目结构

仓库内容

环境配置

node ^5.0.0
yarn ^0.23.0 or npm ^3.0.0

安装

$ git clone <my-project-name>
$ cd <my-project-name>

项目下载完成后,安装依赖

$ yarn  # Install project dependencies 或者`npm install`)

使用

$ yarn start  # Start the development server (or `npm start`)
npm 描述
serve 开发环境 at localhost: 8000
build 构建环境 to ./dist

项目结构

.
├── build                    # All build-related code
├── public                   # Static public assets (not imported anywhere in source code)
├── server                   # Express application that provides webpack middleware
│   └── main.js              # Server application entry point
├── src                      # Application source code
│   ├── index.html           # Main HTML page container for app
│   ├── main.js              # Application bootstrap and rendering
│   ├── normalize.js         # Browser normalization and polyfills
│   ├── components           # Global Reusable Components
│   ├── containers           # Global Reusable Container Components
│   ├── layouts              # Components that dictate major page structure
│   │   └── PageLayout       # Global application layout in which to render routes
│   ├── routes               # Main route definitions and async split points
│   │   ├── index.js         # Bootstrap main application routes with store
│   │   ├── Home             # Fractal route
│   │   │   ├── index.js     # Route definitions and async split points
│   │   │   ├── assets       # Assets required to render components
│   │   │   ├── components   # Presentational React Components
│   │   │   └── routes **    # Fractal sub-routes (** optional)
│   │   └── MyActivity          # Fractal route
│   │       ├── index.js     # MyActivity route definition
│   │       ├── container    # Connect components to actions and store
│   │       ├── modules      # Collections of reducers/constants/actions
│   │       └── routes **    # Fractal sub-routes (** optional)
│   ├── store                # Redux-specific pieces
│   │   ├── createStore.js   # Create and instrument redux store
│   │   └── reducers.js      # Reducer registry and injection
│   └── styles               # Application-wide styles (generally settings)
└── tests                    # Unit tests

注意事项

效果图

维护