1 | <h1 align="center">
|
2 | <img src="https://img.alicdn.com/tfs/TB1OjR6HQL0gK0jSZFAXXcA9pXa-1360-1360.png" alt="Dawn" width="200">
|
3 | <br>Dawn<br>
|
4 | </h1>
|
5 |
|
6 | <h4 align="center">Lightweight task management and build tool.</h4>
|
7 |
|
8 | <p align="center">
|
9 | <a href="https://github.com/alibaba/dawn/blob/master/LICENSE">
|
10 | <img src="https://img.shields.io/npm/l/dawn.svg" alt="LICENSE">
|
11 | </a>
|
12 | <a href="https://www.npmjs.com/package/dawn">
|
13 | <img src="https://img.shields.io/npm/v/dawn.svg" alt="npm version">
|
14 | </a>
|
15 | <a href="https://www.travis-ci.org/alibaba/dawn">
|
16 | <img src="https://coveralls.io/repos/github/alibaba/dawn/badge.svg?branch=dev" alt="Coverage Status">
|
17 | </a>
|
18 | <a href="https://www.npmjs.com/package/dawn">
|
19 | <img src="https://img.shields.io/npm/dt/dawn.svg" alt="npm downloads">
|
20 | </a>
|
21 | </p>
|
22 |
|
23 | <pre align="center">npm i <a href="https://www.npmjs.com/package/dawn">dawn</a> -g</pre>
|
24 |
|
25 | [中文 README](README.md)
|
26 |
|
27 | Dawn is a lightweight task management and build tool for front-end and nodejs. It abstracts the development process into relatively fixed phases and limited operations through `pipeline` and `middleware`, simplifying and unifying the work related to the construction and development of developers.
|
28 |
|
29 | ## Features
|
30 |
|
31 | - Support middleware, easy to extend, and easy to reuse.
|
32 | - Support pipeline, multiple subtasks collaborate to complete the build task.
|
33 | - Simple and consistent command line interfaces that are easy for developers to use.
|
34 | - Manage middleware and engineering templates based on central services.
|
35 | - Support 'private central service', distribution rules, and easy team management.
|
36 |
|
37 | ## Install
|
38 |
|
39 | ```sh
|
40 | $ npm install dawn -g
|
41 | ```
|
42 |
|
43 | ## Use
|
44 | ```sh
|
45 | # 1. Create & Initialize
|
46 | $ dn init -t front
|
47 |
|
48 | # 2. Development & Real-time compilation
|
49 | $ dn dev
|
50 |
|
51 | # 3. Lint & Test
|
52 | $ dn test
|
53 |
|
54 | # 4. Build & pack
|
55 | $ dn build
|
56 | ```
|
57 |
|
58 | ## Example(.dawn.yml or .dawn folder)
|
59 |
|
60 | ```yml
|
61 | # Development & Real-time compilation
|
62 | dev:
|
63 | - name: webpack
|
64 | entry: ./src/*.js
|
65 | template: ./assets/*.html
|
66 | watch: true
|
67 | - name: server
|
68 | port: 8001
|
69 |
|
70 | # Build & pack
|
71 | buid:
|
72 | - name: webpack
|
73 | entry: ./src/*.js
|
74 | template: ./assets/*.html
|
75 | ```
|
76 |
|
77 | ## Documents
|
78 |
|
79 | - Getting Started: [getting-started.md](https://alibaba.github.io/dawn/docs/#!/zh/guide/getting-started)
|
80 | - Pipeline: [pipeline.md](https://alibaba.github.io/dawn/docs/#!/zh/guide/pipeline)
|
81 | - Middleware: [middleware.md](https://alibaba.github.io/dawn/docs/#!/zh/guide/middleware)
|
82 | - More docs: [https://alibaba.github.io/dawn/docs/](https://alibaba.github.io/dawn/docs/)
|
83 |
|
84 |
|
85 | ## Others
|
86 |
|
87 | - [Contributing](CONTRIBUTING.md)
|
88 | - [Changelog](CHANGELOG.md)
|
89 | - [MIT](https://tldrlegal.com/license/mit-license) |
\ | No newline at end of file |