Skip to content

lifeisshit/essay

 
 

Repository files navigation

Build Status Version License

Demo Site

Essay - Simple but not simple blog system

Features

  • Support server rendering.
  • Progressive Web Apps.
  • Lightweight Markdown editor based on VueJS.
  • Support Tag, Category, Search, Page, Comment, Email notification and Draft box.

Bootstrap

Run MongoDB

Please install MongoDB and Node.js, then start the database.

# yourDBpath is your DB folder(Any position)
$ sudo mongod --dbpath yourDBpath

Run Essay

$ git clone https://github.com/wmui/essay

$ cd essay

$ yarn

$ npm run dev # Visit http://127.0.0.1:3025

Tips: Do not use localhost visit the project, because of cookie is domain only support 127.0.0.1.

Global Config

Global config file is server/config/global.config.js, the default configuration like this

module.exports = {
    mongodb: {
        host: '127.0.0.1',
        database: 'essay',
        port: 27017,
        user: '',
        pass: '',
    },
    app: {
        domain: 'http://127.0.0.1:3025',
        siteName: 'Essay',
    },
    // Init admin information
    admin: {
        user: 'admin',
        pass: '123456',
        email: '[email protected]',
    },
    // Secret is very important, please remember to modify it.
    jwt: {
        expiresIn: 365 * 86400,
        secret: 'essay',
    },
    // If you want to send Email when received a comment, please config SMTP Server.
    email: {
        host: 'smtp.qq.com',
        user: '[email protected]',
        pass: '',
    },
    // If you want to support GitHub login,please config clientID and secret.
    github: {
        id: '9588f02db3f89d176f36',
        secret: '10f4f1daa81764664fafb2e50be2c6985ef139f8',
        scope: 'user',
    },
    // If you want to support auto deploy,please config Server IP, repo and path.
    pm2: {
        host: '116.196.17.78',
        repo: '[email protected]:wmui/essay.git',
        path: '/root/essay',
    },
}

Default login email: [email protected] Default login password: 123456

Deploy Essay

If you want to deploy on production environment, you can do just like this

$ git clone https://github.com/wmui/essay

$ cd essay

$ yarn

$ npm run build

$ pm2 start npm --name "Essay" -- start

如果需要自动化部署,可以参考这里Node项目自动化部署

Join us

QQ群:488268810

License

GPL-3.0

About

A blog system based on Nuxt.js

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 46.9%
  • JavaScript 38.1%
  • HTML 7.6%
  • CSS 7.4%