BookLog

README

Pipe

English | 中文

• Introduction
• Features
• Installation
• Documents
• Screenshots
• Build
• Contributions
• License
• Credits

Introduction

Pipe is a small and beautiful blogging platform, login via HacPai to use.

Motivation

Product level:

• There is a lack of platform-level systems on the market that support multiple independent blogs
• Implements B3log Idea

Technical level:

• Take full advantage of golang on the wheel of blogging system
• Blog console using Vue.js for frontend-backend separation

Use cases

• B3log Pipe
• Akkuman 的博客
• Vanessa
• Domolo Reader
• 图解吧

You are also welcome to update this list through PR.

Features

• Multi-user blog platform
• Markdown / Emoji
• Aggregate classification / tag
• Custom navigation
• Themes / I18n
• Atom subscription
• Search
• Hexo/Jekyll Import/Export
• Configurable static separation
• Supports SQLite / MySQL

Installation

Download the latest release package, enter the decompressed directory and run the pipe/pipe.exe executable file.

For more details, refer to the Pipe User Guide. In addition, if you do not want to maintain the server yourself, you can directly use the Pipe Service of our operation and maintenance (for domain name binding, please contact QQ845765).

Documents

• Pipe User Guide
• Pipe Theme Dev Guide
• Postman Collection

Screenshots

Init

Console

Edit

Theme

Build

Need to pre-install the following compilation environment, please use the latest version as far as possible:

1. Go
2. Node.js

Build.sh can be automatically built on Linux, and other platforms can be manually built using the following steps.

Compile the server

go build -i -v

Compile console frond-end

Enter console directory then execute:

npm install && npm run build

• The development environment executes npm run dev and the access port is :3000
• In pipe.json ./pipe needs to be started when AxiosBaseURL is /api, npm run mock is required when /mock is specified

Pack the theme

Go to the theme directory and then:

npm install && npm install --global gulp && gulp

• Development environment implementation gulp watch --theme=ThemeName
• Basic methods and styles under theme/js and theme/scss can be introduced as needed
• Theme development please refer to theme/x/Gina

Contributions

Authors

The main authors of Pipe are Daniel and Vanessa, and all contributors can be found here.

We are very much looking forward to you joining this project. Whether it is using feedback or code patches, it is a full of love for Pipe ❤

Discussion

• Official forum
• Issue

License

Pipe uses GPLv3 as an open source license, please follow it as much as possible, even in China.

Credits

The birth of Pipe is inseparable from the following items:

• jQuery: JavaScript library for themes
• Vue.js: Progressive JavaScript framework
• Nuxt.js: Vue.js framewok
• Vuetify: Vue.js Material component
• Gin: golang HTTP web framework
• GORM: fantastic golang ORM library
• Blackfriday: golang Markdown processor
• SQLite: the most used database enging in the world
• GCache: golang cache
• GoLand: a wonderful IDE

---

A small and beautiful blogging platform, build for the future