# 项目开发

## 如何使用

### 安装

matriks 为一个全局的命令行, 通过一下的命令安装:

```
npm install -g matriks -d
```

### 初始化项目

```
# 注意, 3.0.0 是 seed 的版本, 请确认最新的 seed 版本
matriks init my-project -v 3.0.0

# 安装一些npm依赖
cd my-project
matriks use

# 如果需要 react, 则:
matriks use react

# 启动一个开发环境, 默认是在 http://localhost:5678
matriks dev

# 前端资源打包
matriks dest

# 前端资源打包并启动一个服务器检测打包后资源
matriks prod
```

## !!!!注意!!!! 以下文档 out of date, 请稍等片刻, 我们马上更新

## 初始化项目
 
主要是自动生成 seed/, 横向拷贝 project/

```
./bin/matriks init
```

## 从seed更新project

```
./bin/matriks update
```

## 从project更新 seed

在某些情况下, 会在project里直接修改 seed 的内容 (即非业务代码), 可以用一下的命令回馈到seed项目里

```
./bin/matriks reverse-update
```

## 启动方式：

- 打开package.json 看script  根据命令可找到对应文件
- 启动项目命令 `npm run dev`
- 看到server.dev.js
    - serverStarter: 用express来启服务的，起了之后有个回调
    - serverApp: 用express.static托管静态资源
- 服务起来之后 访问 [localhost](http://localhost:5678/pages/demo-page-react.html)

# 关于npm module - matriks
  
- 入口文件 project/dev/dev-related/locals/lib/main.js

matriks 的使用如下:

```
# 创建项目文件夹, 这是你的业务项目
> mkdir my-project
> cd my-project

# 将当前的业务项目初始化, 填一些东西, 后期可以在业务项目的根目录的 package.json 里修改
> npm init 

# 安装 matriks, 可考虑用cnpm, 不过npm可能会有更新的版本
> npm install matriks -d 
  
# 初始化业务项目 
> ./bin/matriks init

# 初始化之后, 可以通过以下命令进行依赖安装
# 注意: react 是你要使用的技术栈, 也可以后期再追加
> ./bin/matriks use react

# 安装完毕之后, 进入project, 运行项目
> cd project
> npm run dev

# dev server起来之后, 可以访问 http://localhost:5678/pages/home.html

# 其他相关的命令, 可以参照 my-project/project/ 下的 package.json 里的 script 设置
```
  

# 项目任务列表

./doc/tasks.md