TB

A simple & cool blog platform, based on GitHub API, designed for Geeks.

Prerequisites

Operating System: Linux, OS X or Windows.
Node.js Runtime: 8.x or newer; it is recommended that you use LTS Releases.

Language

中文

Links

example-q

Install & Usage

Install

npm install tb-cli -g

Usage

Highly recommend that please use TB-CLI(All usage informations are in there).

Start

Make sure you have installed TB-CLI. More details please click here.

tb init [project-name]
cd [project-name]
npm install // if using yarn: yarn
npm run dev

After generating TB, open your browser and visit http://127.0.0.1:2333.

Development

git clone git@github.com:TB-blog/TB.git
cd TB
npm install // if using yarn: yarn

Attention: You need to add a config file. If you are not a developer, please use TB-CLI to get start.

If you are a developer, you need to create a new file name config.json undered the project's root folder.

{
  "token": "***", // your personal access token
  "nickname": "nickname", // your nickname
  "user": "TB", // your Github username
  "repo": "TB", // your repo name
  "gitalk": {
    "useGitalk": true, // use comment module, more details please see https://github.com/gitalk/gitalk
    "clientID": "***",
    "clientSecret": "***",
    "repo": "TB-comments",
    "owner": "TB",
    "admin": ["TB"]
  }
}

Run npm run dev then open your browser and visit http://127.0.0.1:2333.

Themes

you can run tb theme to check official themes(coming soon).

Contributing

Welcome to contribute by creating issues or sending pull requests. See Contributing Guide for guidelines.

License

MIT

HuangXiZhou / blog

🖖 A simple & cool blog platform, based on GitHub API, designed for Geeks #40

TB