Ruby JavaScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
doc
lib
log
public
spec
test
vendor
.gitignore
.hgignore
.rubocop.yml
.rubocop_todo.yml
Gemfile
Gemfile.lock
Guardfile
LICENSE.txt
Procfile
README.md
Rakefile
config.ru

README.md

shreds

It's a news reader, written in Ruby on Rails.

installation

shreds stands on the shoulder of these giants:

  • postgresql
    @ubuntu:~# apt-get install postgresql postgresql-client libpq-dev

  • redis (>= 2.6)
    @ubuntu:~# add-apt-repository ppa:chris-lea/redis-server && apt-get update && apt-get install redis-server

As for the ruby version, shreds known to work with MRI (>= 2.1). Shreds may work with rubinius and jruby but haven't really tested.

For development or just hacking around shreds, I would recommend using rvm to manage your ruby installation, install rvm in your local home directory. As per the documentation:

~$ gpg --keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3
~$ \curl -L https://get.rvm.io | bash -s stable --ruby=2.1.5

Now you can cd to shreds directory and start with bundle install.

For production environment, just make sure you have sane and recent version of ruby available for your OS distribution and all dependencies above. No need to setup bower if you only want to use shreds, since all assets are already precompiled and committed to the repository.

Before starting the app, there are these few things which should get set up:
First is configuration:

  • Shreds use figaro to manage its configuration. Under config directory, copy application.yml.sample to application.yml, then edit the file according to your need.

  • Also copy database.yml.sample to database.yml and edit the file to adapt with your database configuration.

Second is the database, to setup, type rake db:create then rake db:migrate.

And the last, assuming there is no error, start the application with foreman start. By default, shreds using puma as its server, this may be changed via both Gemfile and Procfile.

License

shreds. 2013-2014. Nurahmadie nurahmadie@gmail.com.

Distributed under MIT/X11 license.

Code Climate