NITROCompetitions is a web-based application for managing institutional funding competitions.
- Create a competition framework
- Publish the competition and associated details
- Ability for faculty and staff to authenticate to NITROCompetitions using any OAuth
provider via the
- Submission of proposals
- A workflow for reviewing submissions via one or more members of a review panel
- Email notifications of submission and review progress
The review criteria and panel setup mirrors the NIH study panel design by default.
NITROCompetitions has the following major models to organize sponsoring organizations, competitions, reviewers, submitters, applicants, and reviews:
- Sponsor: A sponsoring organization running a competition
- Competition: A competition to be managed
- User: An individual who logs in, or is listed with a role, is in the
userstable. Users can have one or more of the following roles:
- key person
- Submission: Submissions have the following:
- applicant (the submitter and applicant can be the same)
- key personnel
- a cover page
- assigned reviewers (assigned by the administrators of the sponsoring organization for the competition)
- Review: Reviews, by default, follow the NIH review criteria, and consist of these review categories:
The categories can be customized on a per-competition basis. A 1-9 score, and descriptive text can be entered for each criterion.
Since NITROCompetitions is a standard Rails app, installing it is just like installing any other Rails app. The current version of the code is tested against Ruby 2.5
See the wiki for install instructions.
Running the test suite
NITROCompetitions has a number of rspec tests. To run these specs run the following command in the project folder:
$ bundle exec rspec
The current version of NITROCompetitions uses OAuth providers for authentication,
If you DO use an OAuth provider, note that you must register this application as a client of that provider (e.g. register the app with Google, Facebook, or whoever your OAuth provider is). Details on how to do that are provider-specific, and the provider's documentation should be consulted in those cases.
Feedback and bug/issue reports
We welcome new ideas and perspectives on the app's usage that have not been considered before. If you have an idea feel free to let us know.
Currently we host our issue and bug tracking system internally. However, if you'd like to submit a github issue, we'll take a look at it and get back to you.
If you want to report a security problem that you feel should be reported privately first, you can email email@example.com.
Please see the code contribution guide for more details.