📝 👷 Add some English docs, Update travis.yml.

2026-11-03 00:14:00 +00:00 · 2018-11-02 19:21:22 +08:00
parent 5d23c77100
commit 3fa24d00fa
8 changed files with 222 additions and 143 deletions
@@ -0,0 +1,73 @@
+# Quick Start
+
+> Before delving into Ant Design React, a good knowledge base of [React](http://facebook.github.io/react/) 、 [ES2015+](http://es6.ruanyifeng.com/) 、 [Antd Design](https://ant.design/docs/react/introduce-cn) .  Learn about [UmiJS](https://umijs.org/) , [Dva](http://github.com/dvajs/dva) . And properly installed and configured [Node.js](https://nodejs.org/) v8 or above, [Git](https://git-scm.com/). It would be helpful if you have pre-existing knowledge on those.
+
+## Installation
+
+```bash
+git clone https://github.com/zuiidea/antd-admin.git my-project
+cd my-project
+```
+
+## Scaffolding
+
+The project layout is as follows:
+
+```bash
+├── dist/               # Default build output directory
+├── mock/               # Mock files 
+├── public/             # Static resource 
+├── src/                # Source code
+│ ├── components/       # Components
+│ ├── e2e/              # Integrated Test Case
+│ ├── layouts/          # Common Layouts
+│ ├── locales/          # i18n resources
+│ ├── models/           # Global dva Model
+│ ├── pages/            # Sub-pages and templates
+│ ├── services/         # Backend Services
+│ │ ├── api.js          # API configuration
+│ │ └── index.js        # API export
+│ ├── themes/           # Themes
+│ │ ├── default.less    # Less variable
+│ │ ├── index.less      # Global style
+│ │ ├── mixin.less      # Less mixin
+│ │ └── vars.less       # Less variable and mixin
+│ ├── utils/            # Utility
+│ │ ├── config.js       # Application configuration
+│ │ ├── constant.js     # Static constant
+│ │ ├── index.js        # Utility methods
+│ │ ├── request.js      # Request function(axios)
+│ │ └── theme.js        # Style variables used in js
+├── .editorconfig       
+├── .env                
+├── .eslintrc           
+├── .gitignore          
+├── .prettierignore     
+├── .prettierrc         
+├── .stylelintrc.json   
+├── .travis.yml         
+└── .umirc.js           
+└──  package.json      
+```
+
+## Development
+
+1. Install Dependencies.
+
+```bash
+yarn install
+```
+
+Or
+
+```bash
+npm install
+```
+
+2. Start local server.
+
+```bash
+npm run start
+```
+
+3.  After the startup is complete, open a browser and visit [http://localhost:7000](http://localhost:7000), If you need to change the startup port, you can configure it in the `.env` file.