Go to file
yafei Lee 942936a7f0 Update README.zh-CN.md 2015-04-27 22:12:18 +08:00
app fix english about page broken on iPhone 2015-04-19 01:26:24 +08:00
bin add spring 2014-05-11 18:54:28 +08:00
config label none translation 2015-04-17 15:13:30 +08:00
db 升级至 rails4 2014-03-28 21:31:21 +08:00
doc 增加图片说明 2014-04-07 08:24:19 +08:00
lib add simple form configure 2014-12-31 01:02:31 +08:00
log 初始化mongoid,rails3.2.6, rspec 2012-06-23 06:19:03 +08:00
public new favico logo 2014-04-02 15:43:45 +08:00
script script 将 rails 3 标识去掉 2014-04-01 13:09:25 +08:00
spec 更新 rails 版本与 rspec 升级 2014-11-25 01:05:00 +08:00
vendor 支持图片上传, 增加rss订阅 2012-06-25 00:09:44 +08:00
.ackrc fix repeat click like button when page refreshing 2015-04-05 09:10:10 +08:00
.gitignore 添加 sidekiq 的布署脚本 2014-04-03 00:01:25 +08:00
.rspec 初始化mongoid,rails3.2.6, rspec 2012-06-23 06:19:03 +08:00
.travis.yml travis ci not use ruby-head 2014-07-21 15:11:35 +08:00
Gemfile add mina sidekiq 2015-04-12 00:59:38 +08:00
Gemfile.lock add mina sidekiq 2015-04-12 00:59:38 +08:00
Guardfile guard file update for 4.0 2014-09-29 22:06:18 +08:00
LICENSE 增加授权MIT 2014-04-02 16:11:38 +08:00
README.md mongoib yml update 2015-04-27 22:10:34 +08:00
README.zh-CN.md Update README.zh-CN.md 2015-04-27 22:12:18 +08:00
Rakefile 整理文件注释 2014-04-01 13:10:22 +08:00
config.ru 整理文件注释 2014-04-01 13:10:22 +08:00

README.md

WBlog

Build Status Code Climate Test Coverage

The missing open source blog system on Ruby on Rails.

WBlog is open source blog which built for mobile first, it's licenced on MIT, use it for free!

中文说明文档

Characteristic:

  • Awful reading feeling for reader
  • Inpendent comment system, store data on your own sever
  • With mardown support, you can post powerful and clean articles

A demo came from my English blog: http://en.yafeilee.me

Power Admin Dashboard: http://en.yafeilee.me/admin, user and password are configurable.

screenshot

Features

  • Responsive, iPhone, iPad, Notebook, PC, all are supported
  • QR Code attached article, scan and share it
  • Inpendent comment system, managed by yourself
  • Markdown supported, code highlight, especially for programmer, like you
  • Personalize it, commercialize it, it all depends on you

Goal

Make it to the best Ruby on Rails Blog system in the world.

Study it locally

WBlog MUST run in Linux or Mac, it depends on Mongodb database. You can run it like a Ruby on Rails project as usual:

  1. Clone it

git clone git@github.com:windy/wblog.git cd wblog

  1. Install dependencies & configure
# Install mongodb ( see how to install it on your platform )
# on Mac, you can install it like this:
brew install mongodb 
bundle install
cp config/application.yml.example config/application.yml
cp config/mongoid.yml.example config/mongoid.yml

Update application.yml & mongoid.yml as you need

  1. Start it
rails s

If there is any error found, please check your database's user and password.

  1. Post the first article

visit: http://127.0.0.1:3000/admin, input your username and password that is just configurated in application.yml. then, post a new article.

OK, That's all.

Deployment

WBlog uses mina as automation deployment tool, uses unicorn as the Rack container.

WBlog recommends nginx as reverse proxy server.

It will be very fast.

Ruby on Rails project deployment is another big topic, I would NOT talk it here.

You can see WBlog wiki for more reading: WBlog 的发布流程(Chinese only now)

Stack

  • Ruby on Rails 4.1.9 / Ruby 2
  • AngularJS
  • Foundation 5
  • mina
  • slim
  • Mongodb