Update README & Add wblog screenshots
3
LICENSE
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) <2012-2014> <liyafei>
|
||||
Copyright (c) <2012-2016> <liyafei>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
|
|
76
README.md
|
@ -12,27 +12,38 @@ WBlog is open source blog which built for mobile first, it's licenced on MIT, us
|
|||
|
||||
Characteristic:
|
||||
|
||||
* Awful reading feeling for reader
|
||||
* Independent comment system, store data on your own sever
|
||||
* With mardown supported, you can post both powerful and clean formatted article(s)
|
||||
* Modern clean reading feelings
|
||||
* Markdown support, give nice formatted articles
|
||||
* Mobile first, responsive page for iPhone, iPad, iMac.
|
||||
* Independent comment system, subscribe system, picture manage system
|
||||
|
||||
A demo came from my English blog: <http://en.yafeilee.me>
|
||||
|
||||
Another demo using my blog: <http://yafeilee.me>
|
||||
|
||||
Power Admin Dashboard: <http://en.yafeilee.me/admin>, user and password are configurable.
|
||||
|
||||
![screenshot](https://github.com/windy/wblog/raw/master/doc/wblog.gif)
|
||||
![screenshot home](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/home.png)
|
||||
![screenshot home small](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/home-small.png)
|
||||
![screenshot home hover](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/home-small-hover.png)
|
||||
![screenshot post](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/post.png)
|
||||
![screenshot post hover](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/post-hover.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/admin-login.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/admin-dashboard.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/admin-post.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s_en/admin-posts.png)
|
||||
|
||||
### System dependencies
|
||||
|
||||
* Ruby ( >= 2.0 )
|
||||
* Mongodb ( >= 2.7 )
|
||||
* Ruby ( = 2.2.3 )
|
||||
* Postgresql ( >= 9.x )
|
||||
* Nginx ( >= 1.4 )
|
||||
|
||||
### Features
|
||||
|
||||
* Responsive, iPhone, iPad, Notebook, PC, all are supported
|
||||
* QR Code attached article, scan and share it
|
||||
* Inpendent comment system, managed by yourself
|
||||
* QR Code, Like button make your article easily sharing with your friends
|
||||
* Inpendent comment system, subscribe system, that all belong to you
|
||||
* Markdown supported, code highlight, especially for programmer, like you
|
||||
* Personalize it, commercialize it, it all depends on you
|
||||
|
||||
|
@ -40,31 +51,37 @@ Power Admin Dashboard: <http://en.yafeilee.me/admin>, user and password are conf
|
|||
|
||||
Make it to the best Ruby on Rails Blog system in the world.
|
||||
|
||||
### Study it locally
|
||||
### Running in development mode
|
||||
|
||||
WBlog MUST run in Linux or Mac, it depends on Mongodb database. You can run it like a Ruby on Rails project as usual:
|
||||
WBlog MUST run in Linux or OSX. I assume you are using OS X 10.
|
||||
|
||||
You can run it like a Ruby on Rails project as usual:
|
||||
|
||||
0. Check dependencies
|
||||
|
||||
```shell
|
||||
ruby -v
|
||||
# 2.2.3
|
||||
postgres --version
|
||||
# 9.x.x
|
||||
```
|
||||
|
||||
1. Clone it
|
||||
|
||||
`git clone git@github.com:windy/wblog.git`
|
||||
|
||||
`cd wblog `
|
||||
`cd wblog`
|
||||
|
||||
2. Install dependencies & configure
|
||||
|
||||
```shell
|
||||
# Install mongodb ( see how to install it on your platform )
|
||||
# on Mac, you can install it like this:
|
||||
brew install mongodb
|
||||
```
|
||||
|
||||
```shell
|
||||
gem install bundler
|
||||
bundle install
|
||||
cp config/application.yml.example config/application.yml
|
||||
cp config/mongoid.yml.example config/mongoid.yml
|
||||
cp config/database.yml.example config/database.yml
|
||||
```
|
||||
|
||||
Update application.yml & mongoid.yml as you need
|
||||
Update `application.yml` & `database.yml` 's content as you need
|
||||
|
||||
3. Start it
|
||||
|
||||
|
@ -72,11 +89,13 @@ WBlog MUST run in Linux or Mac, it depends on Mongodb database. You can run it l
|
|||
rails s
|
||||
```
|
||||
|
||||
Open browser with `http://localhost:3000`
|
||||
|
||||
If there is any error found, please check your database's user and password.
|
||||
|
||||
4. Post the first article
|
||||
4. Post the first blog
|
||||
|
||||
visit: http://127.0.0.1:3000/admin, input your username and password that is just configurated in application.yml.
|
||||
visit: http://localhost:3000/admin, input your username and password configurated in `application.yml`.
|
||||
then, post a new article.
|
||||
|
||||
OK, That's all.
|
||||
|
@ -89,18 +108,19 @@ 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.
|
||||
Ruby on Rails project deployment is another topic, I would NOT talk it here.
|
||||
|
||||
You can read WBlog wiki for more information: [WBlog 的发布流程(Chinese only now)](https://github.com/windy/wblog/wiki)
|
||||
|
||||
### Stack
|
||||
|
||||
* Ruby on Rails 4.2.x / Ruby 2.x
|
||||
* AngularJS
|
||||
* Foundation 5
|
||||
* Ruby on Rails 5.0.0.beta3
|
||||
* Ruby 2.2.3
|
||||
* Turbolinks / SJR
|
||||
* Foundation 6
|
||||
* mina
|
||||
* slim
|
||||
* Mongodb
|
||||
* Postgresql
|
||||
|
||||
|
||||
## Related open source blog systems
|
||||
|
@ -110,3 +130,7 @@ You can read WBlog wiki for more information: [WBlog 的发布流程(Chinese onl
|
|||
* octopress( Github Pages ): <http://octopress.org/>
|
||||
* middleman( Ruby Gem ): Another static blog system <https://github.com/middleman/middleman>
|
||||
* robbin_site( Padrino ): <https://github.com/robbin/robbin_site>
|
||||
|
||||
## License
|
||||
|
||||
MIT.
|
||||
|
|
|
@ -14,52 +14,57 @@ WBlog
|
|||
|
||||
后台禁止爬虫, 使用: <http://yafeilee.me/admin> 访问, 用户名密码可配置.
|
||||
|
||||
![screenshot](https://github.com/windy/wblog/raw/master/doc/wblog.gif)
|
||||
![screenshot home](https://github.com/windy/wblog/raw/master/doc/wblog_s/home.png)
|
||||
![screenshot home small](https://github.com/windy/wblog/raw/master/doc/wblog_s/home-small.png)
|
||||
![screenshot home hover](https://github.com/windy/wblog/raw/master/doc/wblog_s/home-small-hover.png)
|
||||
![screenshot post](https://github.com/windy/wblog/raw/master/doc/wblog_s/post.png)
|
||||
![screenshot post hover](https://github.com/windy/wblog/raw/master/doc/wblog_s/post-hover.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s/admin-login.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s/admin-dashboard.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s/admin-post.png)
|
||||
![screenshot admin](https://github.com/windy/wblog/raw/master/doc/wblog_s/admin-posts.png)
|
||||
|
||||
|
||||
### 为什么重写 WBlog
|
||||
|
||||
老的 WBlog 是两年前构建的, 体验越来越差, 而个人不喜欢托管博客到其他的站点, 又没有合适的 Ruby on Rails 博客系统.
|
||||
### WBlog 的设计目标
|
||||
|
||||
* 优先以手机用户体验为主
|
||||
* 干净的评论系统
|
||||
* 独立干净的评论系统
|
||||
* 良好的博客语法高亮支持
|
||||
* markdown, 简洁而不简单的后台
|
||||
* 要独立站点
|
||||
* 可邮件订阅
|
||||
* Markdown 支持
|
||||
* 尽可能独立
|
||||
|
||||
### 特色
|
||||
|
||||
* 自适应于所有屏幕终端, 方便微信分享与评论
|
||||
* 优先考虑移动用户, 可方便使用二维码扫描与关注
|
||||
* 优先支持移动端访问
|
||||
* 响应式设计, 支持所有屏幕终端, 并且支持微信扫码继续阅读和分享
|
||||
* 自带评论系统, 干净而方便
|
||||
* markdown 支持, 博客语法高亮, 方便技术性博客
|
||||
* 开源可商用, 个性化能力超强 ( 与非独立博客相比 )
|
||||
* Markdown 支持, 博客语法高亮, 方便技术性博客
|
||||
* 开源可商用, 定制能力强
|
||||
|
||||
### 期望
|
||||
|
||||
成为 `Ruby on Rails` 下最好用的独立博客建站系统
|
||||
|
||||
### 本地学习
|
||||
### 开发环境
|
||||
|
||||
WBlog 是一个基本的博客系统, 使用它之前, 你需要准备一台 VPS 独立主机, 安装好 Ruby on Rails 与 Mongodb. 我希望你是熟悉 Ruby on Rails 的, 这样方便定制 WBlog, 现在 WBlog 还太小.
|
||||
WBlog 是一个标准的 Ruby on Rails 应用. 开发环境依赖于:
|
||||
|
||||
假定你有环境后, 克隆本代码. 然后与往常的 Rails 项目一样, 先安装 mongodb
|
||||
|
||||
```shell
|
||||
# Install mongodb ( see how to install it on your platform )
|
||||
# on Mac, you can install it like this:
|
||||
brew install mongodb
|
||||
```
|
||||
* Ruby ( = 2.2.3 )
|
||||
* Postgresql ( >= 9.x )
|
||||
|
||||
配置 WBlog:
|
||||
|
||||
```shell
|
||||
gem install bundler
|
||||
bundle install
|
||||
cp config/application.yml.example config/application.yml
|
||||
cp config/mongoid.yml.example config/mongoid.yml
|
||||
cp config/database.yml.example config/database.yml
|
||||
```
|
||||
|
||||
根据你个人情况, 更新对应的 application.yml & mongoid.yml.
|
||||
更新对应配置: application.yml & database.yml.
|
||||
|
||||
对于配置有不明白的地方, 可以来这里咨询.
|
||||
|
||||
就这样, 可以尝试启动了:
|
||||
|
||||
|
@ -67,20 +72,22 @@ WBlog 是一个基本的博客系统, 使用它之前, 你需要准备一台 VPS
|
|||
rails s
|
||||
```
|
||||
|
||||
登录 http://localhsot:3000/admin 来发布第一篇博客.
|
||||
|
||||
### 发布应用
|
||||
|
||||
WBlog 采用了 `mina` 作为自动化发布工具, 使用 `nginx`, `unicorn` 为相关容器.
|
||||
WBlog 采用了 `mina` 作为自动化发布工具, 使用 `nginx`, `puma` 为相关容器.
|
||||
|
||||
对应的发布流程在: [WBlog 的发布流程](https://github.com/windy/wblog/wiki)
|
||||
|
||||
### 技术栈
|
||||
|
||||
* Ruby on Rails 4.1.8 / Ruby 2.0
|
||||
* AngularJS
|
||||
* Foundation 5
|
||||
* Ruby on Rails 5.0.0
|
||||
* Ruby 2.2.3
|
||||
* Foundation 6
|
||||
* mina
|
||||
* slim
|
||||
* Mongodb
|
||||
* Postgresql
|
||||
|
||||
|
||||
## Ruby 相关开源博客推荐
|
||||
|
|
|
@ -101,7 +101,7 @@ zh-CN:
|
|||
title: '登录后台'
|
||||
username: '用户名'
|
||||
username_placeholder: '管理员账号'
|
||||
password: 'Password'
|
||||
password: '密码'
|
||||
password_placeholder: '管理员密码'
|
||||
login_button: '登录'
|
||||
login_success: '登录成功'
|
||||
|
|
After Width: | Height: | Size: 73 KiB |
After Width: | Height: | Size: 63 KiB |
After Width: | Height: | Size: 103 KiB |
After Width: | Height: | Size: 411 KiB |
After Width: | Height: | Size: 1.2 MiB |
After Width: | Height: | Size: 1.2 MiB |
After Width: | Height: | Size: 98 KiB |
After Width: | Height: | Size: 132 KiB |
After Width: | Height: | Size: 185 KiB |
After Width: | Height: | Size: 70 KiB |
After Width: | Height: | Size: 62 KiB |
After Width: | Height: | Size: 75 KiB |
After Width: | Height: | Size: 156 KiB |
After Width: | Height: | Size: 84 KiB |
After Width: | Height: | Size: 112 KiB |
After Width: | Height: | Size: 160 KiB |
After Width: | Height: | Size: 325 KiB |
After Width: | Height: | Size: 303 KiB |