berkmancenter/curricle

About Curricle

Curricle is a curriculum mapping experiment that serves as an advising tool.

Development

Curricle uses a Rails 5.2 backend running in API mode to serve a GraphQL API and a Vue.js 2 single-page application (via the webpacker gem).

Requirements

• Ruby 2.4.1
• PostgreSQL 9.6
• Node.js 10.16.2 LTS
• Yarn 1.x
• Java 8 Runtime Environment (for Solr search engine)

Installation

1. Install Ruby dependencies:

   • bundle install

2. Install JavaScript dependencies:

   • yarn install

3. Set up host-specific configuration files and edit as needed:

   • cp config/database.yml.example config/database.yml
   • cp config/puma.rb.example config/puma.rb
   • cp config/sunspot.yml.example config/sunspot.yml
   • cp config/webpacker.yml.example config/webpacker.yml

4. Build Vue.js application:

   • bin/webpack

5. Place seed files in filesystem:

   • Obtain these files and place them in lib/seeds/:
     • courses.csv
     • course_meeting_patterns.csv
     • course_instructors.csv
     • divisionMappings.csv

6. Start Solr search engine:

   • bin/rails sunspot:solr:start

7. Create databases and populate with seed data:

   • bin/rails db:setup

8. Create the initial Solr search index:

   • bin/rails sunspot:reindex

9. Start Rails application server:

   • bin/rails s

License

Curricle is licensed under the AGPL

Copyright

2018 President and Fellows of Harvard College