https://github.com/acentro/picco_blog
PiccoBlog is a simple Ruby on Rails markdown blog engine
https://github.com/acentro/picco_blog
blog markdown rails-engine ruby-on-rails
Last synced: 3 months ago
JSON representation
PiccoBlog is a simple Ruby on Rails markdown blog engine
- Host: GitHub
- URL: https://github.com/acentro/picco_blog
- Owner: acentro
- License: mit
- Created: 2016-03-25T19:06:10.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-05T18:59:38.000Z (over 3 years ago)
- Last Synced: 2024-05-20T15:34:01.603Z (11 months ago)
- Topics: blog, markdown, rails-engine, ruby-on-rails
- Language: Ruby
- Homepage: https://acentro.github.io/picco_blog/
- Size: 210 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - picco_blog - PiccoBlog is a simple Ruby on Rails markdown blog engine 🔥 (Happy Exploring 🤘)
README
[](https://badge.fury.io/rb/picco_blog)
PiccoBlog is a simple and light weight markdown blog engine for Ruby on Rails (v4.2.4+) applications.
#### Basic functionality includes:
- Title, body, exceprt
- Featured image
- Tagging
- Pagination
- Member's only flag
- Hidden/Visible state#### TODO:
- Enable autosave feature
- Integrate complete test suite
- Comments are not fully impemented (ActiveRecord or other)#### Dependencies:
- [SimpleMDE v1.11.2 Markdown Editor Library](https://simplemde.com)
- JQuery## Installation
Add this line to your application's Gemfile:
```Ruby
gem 'picco_blog'
```And then execute:
```
$ bundle install
```Generate the install files (migrations and initializer)
```
$ rails generate picco_blog:install
```Run migrations
```
$ rake db:migrate
```If you want to override the default ERB views (most likely you do)
```
$ rails generate picco_blog:views
```Add to `config/routes.rb`
```
mount PiccoBlog::Engine => "/blog"
```Include the PiccoBlog Javascript and CSS Assets. Note: JQuery is required to be loaded first!
Add to `assets/javascripts/application.js`
```
//= require picco_blog/application
```Add to `assets/stylesheets/application.css`
```
*= require picco_blog/application
```Done!
## Configuation
#### Initializer
The default initializer was copied to `config/initializers/picco_blog.rb`. Each configurable option is commented in the file.#### Dependency gems
By default, Dragonfly and Friendly ID gems are utilized. To override these configurations, create `config/initializers/dragonfly.rb` and `config/initializers/friendly_id.rb` initializers.## Issues
Please use the [issue tracker](https://github.com/acentro/picco_blog/issues) if you have any issues.## Change Log
Changes are listed in [CHANGELOG.md](https://github.com/acentro/picco_blog/blob/master/CHANGELOG.md)## Credits & Copyright
[Brandon Bango](https://github.com/brandonbango) - AuthorThis project rocks and uses MIT-LICENSE.