Welcome to the ror-gateway repository! This project serves as a gateway for ROR (Research Organization Registry), providing convenient access to its functionalities.
- Retrieve results by making a call to
/organizations?query=<string>&filter=country.country_code:<COUNTRY_CODE>. Please note that thequeryparameter must be at least 3 characters long. Additionally, you can use the optionalcountryparameter to filter organizations by country. - For a UI integration example, please refer to the "public" folder.
We encourage you to explore and leverage the capabilities of this gateway to interact with the ROR database effectively.
To get started with the ror-gateway, please follow the steps below:
- Clone this repository to your local machine.
- Install the required dependencies by running
npm install. - Configure any necessary environment variables. (see .env.sample)
- Run the application using
npm dev. - Build the application using
npm build. - Run the application using
npm start. - Access the gateway's features via http://localhost:3000.
Feel free to customize and enhance the gateway as per your requirements. We appreciate contributions and suggestions from the community to make this project even better.
If you encounter any issues or have any feedback, please don't hesitate to open an issue in the GitHub repository. We value your input and strive to address any problems promptly.
This project is licensed under the MIT License. You are free to use, modify, and distribute the code by the terms specified in the license.
Thank you for your interest in the ror-gateway project. We hope it proves to be a valuable tool for your research organization-related needs.