Explore and compare open source Ruby libraries
Clone or download
colszowka Merge pull request #300 from rubytoolbox/depfu/update/slim-rails-3.2.0
Update slim-rails: 3.1.3 → 3.2.0 (minor)
Latest commit 516cc06 Oct 10, 2018
Permalink
Failed to load latest commit information.
app Add announcement blog post for db dumps Sep 30, 2018
bin Rubocop is not happy about my code, so let's improve it Sep 30, 2018
config Ignore common exceptions from showing up in appsignal Jul 18, 2018
db Add a note to db:seed script about bin/pull_database Sep 30, 2018
lib Move patterns constants to separate file since rails route reload spi… Jan 12, 2018
log Jedem Anfang wohnt ein Zauber inne Oct 18, 2017
public Add very basic custom error pages Feb 4, 2018
spec Index gems with only pre-release versions as well Sep 27, 2018
tmp Jedem Anfang wohnt ein Zauber inne Oct 18, 2017
vendor Jedem Anfang wohnt ein Zauber inne Oct 18, 2017
.editorconfig Add .editorconfig Oct 18, 2017
.env Mount sidekiq web UI, secured by basic auth Mar 22, 2018
.gitignore Add mirroring of github repo stats Jan 4, 2018
.overcommit.yml bundle exec rubocop/rspec in overcommit Jul 17, 2018
.rspec Add and install rspec-rails Oct 18, 2017
.rubocop Add rubocop, overcommit and guard based on rubytoolbox/catalog#3 Oct 18, 2017
.rubocop.yml Update rubocop & rubocop-rspec and adjust for new cops Jul 17, 2018
.ruby-version Upgrade Ruby Mar 29, 2018
.simplecov Add simplecov Oct 18, 2017
.travis.yml Upgrade Ruby Mar 29, 2018
CODE_OF_CONDUCT.md Add code of conduct Oct 18, 2017
Gemfile Adapt new rails 5.2 defaults as per http://railsdiff.org/5.1.6/5.2.0 Jul 17, 2018
Gemfile.lock Merge pull request #300 from rubytoolbox/depfu/update/slim-rails-3.2.0 Oct 9, 2018
Guardfile Somehow rubocop skipped the frozen string literal comments on the ini… Oct 18, 2017
MIT-LICENSE Rename LICENSE to MIT-LICENSE Oct 18, 2017
Procfile Introduce sidekiq Dec 30, 2017
README.md Add script for pulling production database dumps into local env Sep 30, 2018
Rakefile Somehow rubocop skipped the frozen string literal comments on the ini… Oct 18, 2017
config.ru Add rack-ssl-enforcer and rack-canonical_host Nov 1, 2017
package.json Add yarn and bulma via npm Oct 30, 2017
yarn.lock Improve responsiveness of project stats on mobile Jan 3, 2018

README.md

The Ruby Toolbox

Build Status Depfu

Explore and compare open source Ruby libraries

Development

Prerequisites

The Ruby Toolbox depends on a few utilities which you will need to install before you begin.

PostgreSQL

Redis

Ruby

Install the current project ruby version, preferrably with a Ruby version manager like chruby, rbenv, or rvm

You will also need Bundler for installing the project's dependencies.

Node.js and Yarn

Yarn is used to manage frontend dependencies for the project. It can be installed by following the official installation guide. You will also need to install Node.js.

Running the application

  1. Start postgres and redis
  2. Install the project's dependencies by running bundle install
  3. Prepare the database with rake db:setup
  4. Optional but recommended: Import a production database dump using bin/pull_database
  5. Install the frontend dependencies using yarn install
  6. In order to access the Github GraphQL API for pulling repo data, you need to create a OAuth token as per Github's documentation. No auth scopes are needed. Place the token as GITHUB_TOKEN=yourtoken in .env.local and .env.local.test.
  7. Run the services with foreman start. You can access the site at http://localhost:5000

Further steps

  • You can run the test suite with bundle exec rspec
  • You can check code style with bundle exec rubocop
  • During development you can launch guard using bundle exec guard to continuously check your changes
  • The repo has overcommit git hooks set up to check your changes before commit, push etc. You can set it up once with bundle exec overcommit --install. Whenever the hook config file .overcommit.yml changes, you need to verify it's contents and approve the changes with bundle exec overcommit --sign
  • You can find the sidekiq web UI at http://localhost:5000/ops/sidekiq. Username can be empty, the default password is development.

Code of Conduct

Everyone participating in this project's development, issue trackers and other channels is expected to follow our Code of Conduct

License

This project is available as open source under the terms of the MIT License.