init

Author: kevinsilvrr

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+  indent_style = space
+  indent_size = 2
+  end_of_line = lf
+  charset = utf-8
+  trim_trailing_whitespace = true
+  insert_final_newline = true
+
+[*.md]
+  trim_trailing_whitespace = false

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+
+  root: true,
+  parser: 'babel-eslint',
+  env: {
+    browser: true,
+    node: true
+  },
+  extends: '',
+  // required to lint *.vue files
+  plugins: [
+    'html'
+  ],
+  // add your custom rules here
+  rules: {
+    'space-before-function-paren': [
+      0,
+      {
+        anonymous: 'always',
+        named: 'never'
+      }
+    ],
+    'no-unused-vars': 0
+  },
+  globals: {}
+}

.gitignore

@@ -0,0 +1,22 @@
+# dependencies
+node_modules
+
+# logs
+npm-debug.log
+
+# Nuxt build
+.nuxt
+
+# Nuxt generate
+dist
+
+# pwa
+sw.*
+
+# public
+public/*
+
+NOTE.md
+
+build
+

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+    - "8.9.1"
+install:
+    - yarn
+script:
+    - npm run build

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch via NPM",
+            "runtimeExecutable": "yarn",
+            "runtimeArgs": [
+                "server"
+            ],
+            "restart": true
+        }
+    ]
+}

README.en.md

@@ -0,0 +1,93 @@
+<a href="https://travis-ci.org/wmui/vueblog"><img src="https://travis-ci.org/wmui/vueblog.svg?branch=master" alt="Build Status"></a>
+<a href="https://github.com/wmui/vueblog"><img src="https://img.shields.io/badge/license-AGPL-blue.svg" alt="License"></a>
+
+## VueBlog
+
+[中文文档](https://github.com/wmui/vueblog/blob/master/README.md)
+
+<div style="text-align:center;">
+  <p><a href="https://www.86886.wang" target="_blank">Live Demo</a></p>
+</div>
+
+VueBlog is a lightweight blog application
+
+### Technology stack
+
+- FrontEnd: Nuxt.js and Vuex
+- BackEnd: Mongoose and Koa
+
+### Features
+
+- Server Side Rendering.
+- Progressive Web App.
+- A lightweight markdown editor based on Vue.js.
+
+### Build Setup
+
+First install [MongoDB](https://www.mongodb.com/download-center?jmp=nav#community) and [Node.js](https://nodejs.org/en/)
+
+``` bash
+# install dependencies
+npm install # or yarn
+
+# serve in dev mode, with hot reload at http://127.0.0.1:3000
+npm run dev
+
+# build for production
+npm run build
+
+# serve in production mode
+npm start
+```
+
+**Tips：** Useing `http://127.0.0.1:3000` replace `http://localhost:3000` visit your local project
+
+### Global config
+
+The config file is `/server/config/index.js`.
+
+The default uername is `q` and password is `q`.
+
+```javascript
+export default {
+  user: {
+    role: 'superAdmin',
+    username: 'q',
+    password: 'q',
+    email: '[email protected]',
+    nickname: 'VueBlog',
+    motto: 'Never too old to learn',
+    avatar: 'avatar.png'
+  },
+  jwt: {
+    secret: 'vueblog'
+  },
+  mongodb: {
+    host: '127.0.0.1',
+    database: 'vueblog',
+    port: 27017,
+    username: '',
+    password: ''
+  },
+  githubConfig: {
+    githubClient: '',
+    githubSecret: '',
+    scope: 'user'
+  },
+  emailConfig: {
+    user: '',
+    pass: ''
+  },
+  app: {
+    domain: '',
+    host: '127.0.0.1',
+    port: 3000,
+    routerBaseApi: 'api'
+  }
+}
+
+```
+
+### License
+
+[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)

README.md

@@ -0,0 +1,115 @@
+
+<a href="https://travis-ci.org/wmui/vueblog"><img src="https://travis-ci.org/wmui/vueblog.svg?branch=master" alt="Build Status"></a>
+<a href="https://github.com/wmui/vueblog"><img src="https://img.shields.io/badge/license-AGPL-blue.svg" alt="License"></a>
+
+## VueBlog
+
+[English Doc](https://github.com/wmui/vueblog/blob/master/README.en.md)
+
+<div style="text-align:center;">
+  <p><a href="https://www.86886.wang" target="_blank">演示站</a></p>
+</div>
+
+VueBlog是一个轻量级的博客应用
+
+### 技术栈
+
+- 前端：Nuxt.js + Vuex
+- 后端: Mongoose + Koa
+
+### 功能特性
+
+- 支持服务端渲染
+- PWA渐进式web应用
+- 轻量级Markdown编辑器
+- 支持标签、归档、搜索草稿箱等功能
+
+### 本地运行
+
+安装[MongoDB](https://www.mongodb.com/download-center?jmp=nav#community)数据库和[Node.js](https://nodejs.org/en/)环境。
+
+``` bash
+# install dependencies
+npm install # or yarn
+
+# serve in dev mode, with hot reload at http://127.0.0.1:3000
+npm run dev
+
+# build for production
+npm run build
+
+# serve in production mode
+npm start
+```
+
+**注意：** 不要使用`http://localhost:3000`访问，而是用`http://127.0.0.1:3000`
+
+### 全局配置
+
+全局配置文件`/server/config/index.js`
+
+默认用户名：q，默认密码：q  
+
+```javascript
+export default {
+  // 初始化管理员信息，后台可以修改
+  user: {
+    role: 'superAdmin',
+    username: 'q',
+    password: 'q',
+    email: '[email protected]',
+    nickname: 'VueBlog',
+    motto: 'Never too old to learn',
+    avatar: 'avatar.png'
+  },
+  jwt: {
+    secret: 'vueblog'
+  },
+  // 数据库配置，默认即可
+  mongodb: {
+    host: '127.0.0.1',
+    database: 'vueblog',
+    port: 27017,
+    username: '',
+    password: ''
+  },
+  // 可选，评论功能需要配置github登录的密钥
+  githubConfig: {
+    githubClient: '',
+    githubSecret: '',
+    scope: 'user'
+  },
+  // 可选，评论通知的SMTP邮箱配置，目前只支持qq邮箱
+  emailConfig: {
+    user: '',
+    pass: ''
+  },
+  app: {
+    domain: '', // 可选，线上域名，比如https://www.86886.wang
+    host: '127.0.0.1',
+    port: 3000,
+    routerBaseApi: 'api'
+  }
+}
+```
+
+### 线上部署
+
+如果需要部署到线上看下效果，可以参考这里[Nuxt项目自动化部署手册](https://github.com/wmui/web-deploy)
+
+如果感觉自动化部署太麻烦，可以简单部署上线
+
+```bash
+# install dependencies
+npm install # or yarn
+
+# build for production
+npm run build
+
+# serve in production mode
+pm2 start npm --name "vueblog" -- start
+```
+
+### 开源协议
+
+[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)