Northwestern University Core Facility Management Software (NUCore)
Ruby HTML CoffeeScript JavaScript Other
vandrijevik [#139111] Only show reservations with state new or inprocess in My Re…
…servations (#1601)

Only show reservations with state new or inprocess reservations in My Reservations
Latest commit 6c41631 Jun 21, 2018
Permalink
Failed to load latest commit information.
app [#139111] Only show reservations with state new or inprocess in My Re… Jun 21, 2018
bin Update to Rails 5.0 (#1469) May 11, 2018
config Split facility sub-items to their own columns (#1570) Jun 18, 2018
db [#73287] Add ability to suspend a user (#1481) Apr 11, 2018
doc Replace factory girl with factory bot (#1243) Dec 20, 2017
docker/oracle Read database.yml for docker setup with aliases (#1222) Sep 18, 2017
docs Create CONTRIBUTING.md (#1451) Mar 19, 2018
lib [#141837] Remove ability for account managers to edit user details (#… May 15, 2018
public [#88660] Update bulk order template to include notes Nov 19, 2014
script [#125418] Apply RubocopAutocorrect what is possible Mar 23, 2016
spec [#139111] Only show reservations with state new or inprocess in My Re… Jun 21, 2018
tmp Ensure tmp exists at app root, and use it (#575) May 6, 2016
vendor [#142184] Allow customizing error message for non-existent users sign… Jun 8, 2018
.codeclimate.yml Update rubocop (#1512) Apr 20, 2018
.csslintrc Add CSS and CoffeeScript linter configs (#503) May 2, 2016
.gitignore [#132541, #136148] update ruby to 2.4 (#1150) Jul 10, 2017
.haml-lint.yml Disable UnnecessaryStringOutput haml linter (#1131) Jun 26, 2017
.haml-lint_todo.yml [#140406] Remove old filtering code (#1505) Apr 17, 2018
.rspec Upgrade to RSpec 3.3 Sep 21, 2015
.rubocop-txi.yml Update rubocop (#1512) Apr 20, 2018
.rubocop.yml [#132541, #136148] update ruby to 2.4 (#1150) Jul 10, 2017
.rubocop_todo.yml Update rubocop (#1512) Apr 20, 2018
.ruby-version [#132541, #136148] update ruby to 2.4 (#1150) Jul 10, 2017
Capfile [#141036111] Add Rollbar for Open Deployment (#926) Mar 13, 2017
Gemfile Add gems to suport ed25519 keys in capistrano (#1578) Jun 1, 2018
Gemfile.lock [Security] Bump sprockets from 3.7.1 to 3.7.2 (#1598) Jun 19, 2018
Guardfile Update Guardfile to run javascript and vendor specs Oct 9, 2015
LICENSE Task #33697 : Copyright notice Jun 28, 2011
README.md Remove :oracle group from Gemfile (#1546) May 11, 2018
Rakefile [#125418] Apply RubocopAutocorrect what is possible Mar 23, 2016
circle.yml Remove :oracle group from Gemfile (#1546) May 11, 2018
coffeelint.json [#137282] Add timed service to existing order (#1215) Sep 11, 2017
config.ru [#125418] Apply RubocopAutocorrect what is possible Mar 23, 2016

README.md

NUcore Open

Open source version of Northwestern University Core Facility Management Software

Quickstart

Welcome to NUcore! This guide will help you get a development environment up and running. It makes a few assumptions:

  1. You write code on a Mac.
  2. You have a running Oracle or MySQL instance with two brand new databases. (Oracle setup instructions here.)
  3. You have the following installed:

Spin it up

  1. Download the project code from Github

    git clone git@github.com:tablexi/nucore-open.git nucore
    
  2. Install dependencies

    cd nucore
    bundle install
    
  3. Configure your databases

    cp config/database.yml.mysql.template config/database.yml
    

    Edit the adapter, database, username, and password settings for both the development and test DBs to match your database instance

  4. Configure your secrets

cp config/secrets.yml.template config/secrets.yml
rake secret
  • Paste the output from rake secret into config/secrets.yml for both development/secret_key_base and test/secret_key_base
  1. Set up databases

    rake db:setup
    
  2. Seed your development database

    rake demo:seed
    
  3. Configure your file storage

    By default, files are stored on the local filesystem. If you wish to use Amazon's S3 instead, create a local settings override file such as config/settings/development.local.yml or config/settings/production.local.yml and include the following, substituting your AWS settings:

    paperclip:
      storage: fog
      fog_credentials:
        provider: AWS
        aws_access_key_id: YOUR_S3_KEY_GOES_HERE
        aws_secret_access_key: YOUR_S3_SECRET_KEY_GOES_HERE
      fog_directory: YOUR_S3_BUCKET_NAME_GOES_HERE
      fog_public: false
      path: ":class/:attachment/:id_partition/:style/:safe_filename"
    
  4. Start your server

    bin/rails s
    
  5. Log in

    Visit http://localhost:3000

    demo:seed creates several users with various permissions. All users have the default password of password

    Email/username Role
    admin@example.com Admin
    ppi123@example.com PI
    sst123@example.com Normal User
    ast123@example.com Facility Staff
    ddi123@example.com Facility Director
  6. Play around! You're running NUcore!

  7. Run delayed_job to support in-browser email previews.

    Run delayed jobs indefinitely in the background:

    ./script/delayed_job start
    

    Or run delayed jobs once for one-off jobs:

    ./script/delayed_job run
    

Test it

NUcore uses Rspec to run tests. Try any of the following from NUcore's root directory.

  • To run all tests (this will take awhile!) rake spec

  • To run just the model tests rake spec:models

  • To run just the controller tests rake spec:controllers

Optional Modules

The following modules are provided as optional features via Rails engines. These are enabled by adding the appropriate engine to your Gemfile (all are on by default). They exist in the vendor/engines directory.

Engine-specific migrations should live in the engine's db/migrate directory and use an engine initializer to add that path to the list of paths Rails checks. If you need to disable an engine, you can undo all of the engine's migrations with the rake engines:db:migrate_down[ENGINE_NAME] task.

Learn more

There are valuable resources in the NUcore's doc directory.