Rails project that integrates Trello for scrum management that's hopefully smarter than the average scrum.
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
lib
public
storage
test
vendor
.gitignore
.rubocop.yml
.ruby-version
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
config.ru
package.json

README.md

Scrumwell

Rails project that integrates Trello for scrum management that's hopefully smarter than the average sprint.

Installation

Srcrumwell is designed to be run locally on the Rails development server with a PostgreSQL database.

Prerequisites

For help setting up Rails, see gorails.com.

Rails

Install the application itself using git:

git clone https://github.com/klenwell/scrumwell.git

Install gems:

cd scrumwell
bundle install

Credentials

Credentials are encrypted in credentials.yml.enc.

To use the existing credentials.yml.enc file, you'll need to get the key from the project's current maintainer and add it to the master.key file.

To edit the credentials.yml.enc file:

EDITOR=vi rails credentials:edit

To reset the encrypted credentials.yml.enc file:

rm config/credentials.yml.enc
EDITOR=vi rails credentials:edit

Then copy-paste contents of credentials.yml-dist where indicated below into vi buffer and update values as needed.

Database

Create your application's postgres database user:

# Use postgres command line interface
psql

# SQL commands
CREATE USER scrumwell WITH PASSWORD 'scrumwell';
ALTER ROLE scrumwell SUPERUSER;

Setup database:

bundle exec rake db:setup
bundle exec rake db:setup RAILS_ENV=test

Development

Run Tests

bundle exec rake test

Code Analysis

Brakeman and Rubocop are configured to run automatically whenever tests are run. To run them independently:

# security analysis: this will provide additional detail
bundle exec brakeman

# style analysis
bundle exec rubocop

False Positives

To ignore Brakeman warnings, use the -I option:

bundle exec brakeman -I

For more information, see https://brakemanscanner.org/docs/ignoring_false_positives/.

Local Server

To start the local server:

bundle exec rails server -b 0.0.0.0 -p 3000

From your browser, head to http://localhost:3000