add readme

Author: Frand

README.md

@@ -1,2 +1,59 @@
 ## NC-EXAMPLE
 an simple nodeclub example project realize by koa
+
+## startup
+
+1. clone本项目
+2. 准备项目环境
+
+	- `node v4.3.0`
+	- `mongodb v3.0.7`
+
+3. 修改项目根目录下配置文件`config.js`
+4. 安装项目依赖
+
+	- `$npm install`
+
+5. 启动项目
+
+	- `$node app`
+
+## feature
+
+项目特性列表如下:
+
+- mongoose数据存储
+- koa-ejs页面渲染
+- koa-router处理路由
+- koa-session控制用户登录
+- koa-send控制静态文件访问
+- koa-compress启用gzip压缩
+- koa-request-log记录请求日志
+- koa-less使用less编译样式文件
+- koa-etag/koa-conditional-get添加缓存功能
+
+## showing
+
+- 首页
+
+[首页](http://www.startexample.com/images/assist/20160417/index.png)
+
+- 主题详情
+
+[主题详情](http://www.startexample.com/images/assist/20160417/topicDetail.png)
+
+- 主题发表
+
+[主题发表](http://www.startexample.com/images/assist/20160417/publishTopic.png)
+
+- 主题回复
+
+[主题回复](http://www.startexample.com/images/assist/20160417/reply.png)
+
+- 用户登录
+
+[用户登录](http://www.startexample.com/images/assist/20160417/login.png)
+
+- 用户注册
+
+[用户注册](http://www.startexample.com/images/assist/20160417/registry.png)

config.js

@@ -17,23 +17,6 @@ let config = {
     mongodb: {
       db: 'mongodb://127.0.0.1/nc-example',
       poolSize: 5
-    },
-
-    // mysql 配置, 当前未使用
-    mysql: {
-      auth: {
-        user: 'username',
-        pass: 'password'
-      },
-      conn: {
-        host: '127.0.0.1',
-        dialect: 'mysql',
-        pool: {
-          max: 5,
-          min: 0,
-          idle: 10000
-        }
-      }
     }
 };
 

public/css/_partial/content.less

@@ -74,7 +74,9 @@
 		margin-bottom: 10px;
 
 		input{
-			font-size: 20px;
+			font-size: 16px;
+			width: 300px;
+			padding: 5px;
 		}
 	}
 

public/css/_partial/sidebar.less

@@ -30,7 +30,7 @@
 			    font-style: italic;
     		}
 
-    		span:nth-child(n+9){
+    		span:nth-child(n+10){
     			color: #BBB;
     		}
     	}

public/css/style.css

@@ -2,7 +2,7 @@
 	<% var topics = locals.topics || [] %>
 	<% topics.forEach(function(v){ %>
 	<div>
-		<a href='/user/<%= v.author %>'><%= v.author %></a>
+		<a href='/user/<%= v.author %>'>@<%= v.author %></a>
 		<a href='/topic/detail/<%= v._id %>'><%= v.title %></a>
 		<span><%= v.createAt %></span>
 	</div>

views/index.html

@@ -4,7 +4,7 @@
 </div>
 <!-- 默认sidebar -->
 <div class="introBox">
-	<p>[NC-EXAMPLE]使用koa重新实现的一个简单nodeclub, 具体使用了如下技术点:</p>
+	<p>[NC-EXAMPLE]精简版nodeclub, 技术点如下:</p>
 	<div class="fns">
 		<span>mongoose数据存储</span>
 		<span>koa-router处理路由</span>
@@ -14,7 +14,7 @@
 		<span>koa-request-log记录请求日志</span>
 		<span>koa-session控制用户登录</span>
 		<span>koa-compress启用gzip压缩</span>
-		<span>koa-etag~添加缓存功能</span>
+		<span>koa-etag/koa-conditional-get添加缓存功能</span>
 		<span>mocha,chai单元测试</span>
 	</div>
 </div>