-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Research Organization Registry (ROR) developer wiki. This wiki contains information for developers working on projects in https://github.com/ror-community . User documentation is located at https://ror.readme.io . If you're interested in contributing to ROR projects but aren't sure where to start, contact [email protected] .
RESTful API that allows searching/retrieving ROR records. Also contains private routes for indexing data into Elasticsearch and generating new IDs. Docker container deployed to AWS Fargate via Gitub Actions.
- Language: Python (Django)
- User docs: https://ror.readme.io/docs/rest-api
- Github repo: ror-api
- URL (production): https://api.ror.org/organizations
- URL (staging): https://api.staging.ror.org/organizations
- URL (dev): https://api.dev.ror.org/organizations
JS app the allows searching/viewing ROR records in a browser. Deployed to AWS S3/Cloudfront via Github Actions.
- Language: Javascript (Ember)
- User docs: https://ror.readme.io/docs/web-search-interface
- Github repo: ror-app
- URL (production): https://ror.org/search
- URL (staging): https://staging.ror.org/search
- URL (dev): https://dev.ror.org/search
Static site with informational content about ROR. Deployed to AWS S3/Cloudfront via Github Actions.
- Language: Static HTML generated by Middleman Ruby app
- Github repo: ror-site
- URL (production): https://ror.org
- URL (staging): https://staging.ror.org
- URL (dev): https://dev.ror.org
UI app for generating new or updated ROR record files for download to a local machine. In practice, this is not used by humans, but by a script that takes a CSV as input and uses Selenium to complete the form to create a record each row. Deployed to AWS S3/Cloudfront via Github Actions.
- Language: Javascript (VueJS + JSONForms)
- Github repo: leo-form
- URL (production): https://leo.ror.org
- URL (staging): https://leo.staging.ror.org
- URL (dev): https://leo.dev.ror.org
Middleware app used for handling requests to protected ROR API routes from other apps/code (such as leo-form and scripts used in Github actions). Used to centralize handling of protected requests while obscuring requests paths and credentials. Docker container deployed to AWS Fargate via Gitub Actions.
- Language: Python (FastAPI)
- Github repo: generate-id
- URL (production): https://generateid.ror.org
- URL (staging): https://generateid.staging.ror.org
- URL (dev): https://generateid.dev.ror.org
OpenRefine extension that allows matching organization names to ROR IDs using the ROR REST API. Docker container deployed to AWS Fargate via ??? This receives very little use and hasn't been updated since its initial launch.
- Language: Ruby
- User docs: https://ror.readme.io/docs/openrefine-reconciler
- Github repo: ror-reconciler
- URL (production): https://reconcile.ror.org/reconcile
- URL (staging): https://reconcile.staging.ror.org/reconcile
- URL (dev): https://reconcile.dev.ror.org/reconcile
Data in ROR records is managed through a process that uses a variety of tools and technologies rather than a single app. Records are created/updated as individual JSON files and various scripts are run via Github Actions to validate the files, upload them to AWS S3, index them into AWS Elasticsearch and generate a new data dump file. For technical details see ROR record curation process.
- User docs: https://github.com/ror-community/ror-records#ror-data-release-creation--deployment-steps
- Language: (mostly) Python
- Github repositories: ror-updates, ror-records, ror-data, validation-suite and curation_ops. There are also dev repos for testing the deployment process: ror-data-test and dev-ror-records