Venice

GitHub version Code Climate

Where art meets technology.

v e n i c e is boilderplate website & blog implementation based on Character library. It's used as boilerplate for new Rails projects or quick prototypes.

Homepage: https://github.com/alexkravets/venice

Installation

It assumes you have a machine equipped with Ruby & Mongodb.

  1. Install the Venice gem using the RubyGems package manager:
  gem install venice-chr
  1. Then kick off a new project:
  venice new your-project-name

Shortcuts

We’ve also included some handy shortcuts with Venice:

  • Install dependencies and clear the Git remote:
  venice setup

Default admin account is [email protected]:password.

  • Run the deploy (supported platforms: Heroku):
  venice deploy

Default admin account: is [email protected]:password. After deploy is finished, please login and create a new account, then remove default one.

  • Start Venice server:
  rails s

Venice is based on a bunch of open source gems. You might be interested to have a look into those to get better understanding of how things do work inside:

  • Character: Powerful responsive javascript CMS for apps
  • Formagic: Building forms with CoffeeScript
  • Journal: Posts and pages implementation with templates and CMS modules
  • Tape: Basic RSS reader that integrates into CMS
  • Ants: Utility gem with helpers and concerns that are used on the backend and CMS
  • Loft: Media assets manager for Character CMS
  • Mongosteen: An easy way to add CRUD actions for Mongoid models

Contributing

If you'd like to contribute a feature or bugfix: Thanks! To make sure your fix/feature has a high chance of being included, please read the following guidelines:

  1. Fork the repository
  2. Make your changes
  3. Push your branch to your fork
  4. Post a pull request.

Thank you to all the contributors!