kschumy / ada-prs

Application for tracking and providing feedback on Ada student PRs

Ada Pull Request Application

This app is created to use the GitHub API to read pull request data for configured projects in order to determine whether or not a student has submitted their assignment.

Overall Setup

To setup the application overall, it requires the initial seeding of classroom information as well as students.

Project Setup

Each individual project must be added to the list of repositories to be set up for configuration. The URL for each individual repo should be in the "Ada-CX/ProjectName" format. No additional portion of the URL needs to be provided. The repo configuration shall indicate whether or not the project was set up as individual or group, in order for the logic to appropriately determine submissions.

Roles

Ideally this application has configuration for two different roles, Instructor and Student. Instructors shall have access to configuration for Students, Assignments and submitting Feedback. Students shall have access to their submissions and the corresponding URLs to their PR as well as feedback (once submitted).

Development Setup

1. Clone this repo
2. rvm install ruby-2.2.1
3. gem install bundle
4. bundle install
5. Email Charles to get the lib/seeds/students.csv file, and add it to the project. It will be ignored by git.
6. bin/rake db:migrate
7. Register a new app on github, with a callback URL of http://localhost:3000/auth/github/callback
8. touch .env
9. Add the GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET from the app you just registered to the .env file
10. rails s
11. App should be running at localhost:3000

IMPORTANT!

Things NOT done from Rails Guide update list

• Autoloading is Disabled After Booting in the Production Environment
• Removed Support for Legacy mysql Database Adapter
• Removed Support for Debugger
• Use bin/rails for running tasks and tests - nothing to change(?)
• ActionController::Parameters No Longer Inherits from HashWithIndifferentAccess
• protect_from_forgery Now Defaults to prepend: false
• Default Template Handler is Now RAW
• Added Wildcard Matching for Template Dependencies
• ActionView::Helpers::RecordTagHelper moved to external gem (record_tag_helper)
• Removed Support for protected_attributes Gem
• Removed support for activerecord-deprecated_finders gem
• ActiveSupport::TestCase Default Test Order is Now Random
• ActionController::Live became a Concern
• New Framework Defaults (several!)
• Changes with JSON/JSONB serialization
• Expiry in signed or encrypted cookie is now embedded in the cookies values

Issues

1. enum gem no longer supported.
2. btree thing missing from schema
3. workaround for tests is probably wrong (or maybe not?? https://stackoverflow.com/questions/43797133/controller-spec-unknown-keyword-id)
4. gems for markdown preview no longer works or is supported. List is possible replacements
   • draft-js (Docs) - also has an active community building resources
   • react-markdown-editor
   • react-mde

Kirsten's Random Notes

from /Users/kirstenschumy/Documents/Ada/capstone-project/ada-prs/app/assets/javascripts/application.js
//= require epiceditor

Significant Changes

• repos table renamed to assignments
• cohort table renamed to classroom
• front-end deleted