{"id":13558118,"url":"https://github.com/datacite/lupo","last_synced_at":"2026-01-29T22:11:16.672Z","repository":{"id":21288785,"uuid":"91705241","full_name":"datacite/lupo","owner":"datacite","description":"DataCite REST API","archived":false,"fork":false,"pushed_at":"2024-10-29T08:05:10.000Z","size":16205,"stargazers_count":11,"open_issues_count":78,"forks_count":8,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-29T09:22:28.162Z","etag":null,"topics":["doi","graphql","jsonapi","lupo","rails-api","ruby"],"latest_commit_sha":null,"homepage":"https://api.datacite.org","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datacite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json"}},"created_at":"2017-05-18T14:47:24.000Z","updated_at":"2024-10-24T07:07:00.000Z","dependencies_parsed_at":"2023-10-03T12:24:57.539Z","dependency_job_id":"d177f030-a560-4ee7-93c7-563490a92633","html_url":"https://github.com/datacite/lupo","commit_stats":null,"previous_names":[],"tags_count":1184,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datacite%2Flupo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datacite%2Flupo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datacite%2Flupo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datacite%2Flupo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datacite","download_url":"https://codeload.github.com/datacite/lupo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247002538,"owners_count":20867473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doi","graphql","jsonapi","lupo","rails-api","ruby"],"created_at":"2024-08-01T12:04:45.426Z","updated_at":"2026-01-29T22:11:16.666Z","avatar_url":"https://github.com/datacite.png","language":"Ruby","readme":"# DataCite REST API\n\n[![Identifier](https://img.shields.io/badge/doi-10.5438%2F8gb0--v673-fca709.svg)](https://doi.org/10.5438/8gb0-v673)\n![Release](https://github.com/datacite/lupo/workflows/Release/badge.svg)\n[![Maintainability](https://api.codeclimate.com/v1/badges/dddd95f9f6f354b7af93/maintainability)](https://codeclimate.com/github/datacite/lupo/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/dddd95f9f6f354b7af93/test_coverage)](https://codeclimate.com/github/datacite/lupo/test_coverage)\n\nRails API application for managing DataCite providers, clients, prefixes and DOIs. The API uses the [JSONAPI](http://jsonapi.org/) specification.\n\n## Key Concepts\n\n*   **Provider**: An organization that manages clients (e.g., a university or research institute).\n*   **Client**: A data center or repository that registers DOIs.\n*   **DOI**: Digital Object Identifier, the core entity managed by the system.\n*   **Prefix**: DOIs are assigned within a prefix (e.g., 10.1234).\n\n## Tech Stack\n\n*   Ruby on Rails\n*   MySQL\n*   OpenSearch (Elasticsearch)\n*   Memcached\n*   S3 compatible storage (Minio in dev and test)\n*   Shoryuken (AWS SQS) for Background Jobs\n    * Inline Background Jobs in development and test environments\n\n## Development\n\nWe use Docker Compose for development to ensure a consistent environment.\n\n### Project Structure\n\n*   `app/graphql`: GraphQL schema, types, mutations, and resolvers.\n*   `app/models`: Core domain logic (Provider, Client, Doi, etc.).\n*   `app/jobs`: Background jobs (Shoryuken).\n*   `app/serializers`: JSONAPI serializers.\n*   `app/controllers`: API controllers.\n\n### Prerequisites\n\n*   Docker\n*   Docker Compose\n\n### Configuration\n\nYou do not need a complicated `.env` file to get started. Reasonable defaults are set for both development and test environments and are loaded automatically by Rails. You can start with an empty `.env` file or override specific values as needed.\n\n### Starting the Application\n\nTo build and start the application and its dependencies:\n\n```bash\ndocker-compose -f docker-compose.yml -f docker-compose.local.yml up --build\n```\n\n### Database Setup\n\nOnce the containers are running, you can set up the database (create, schema load, seed):\n\n```bash\ndocker-compose exec web bundle exec rake db:setup RAILS_ENV=development\n```\n### Accessing the Application\n\nThe application will be available at `http://localhost:8065`.\n\nUseful endpoints to visit include:\n*   `http://localhost:8065/dois`\n*   `http://localhost:8065/clients`\n\n### Running Tests\n\nTo run the entire test suite:\n\n```bash\ndocker-compose exec web bundle exec rspec\n```\n\nTo run a specific test file:\n\n```bash\ndocker-compose exec web bundle exec rspec spec/models/doi_spec.rb\n```\n\nTo run a specific test at a specific line:\n\n```bash\ndocker-compose exec web bundle exec rspec spec/models/doi_spec.rb:10\n```\n\n### Linting and Checking\n\nTo run code linting:\n\n```bash\ndocker-compose exec web bundle exec rubocop\n```\n\nTo run security checks:\n\n```bash\ndocker-compose exec web bundle exec brakeman\n```\n\nTo check for vulnerable gem versions:\n\n```bash\ndocker-compose exec web bundle exec bundle-audit check --update\n```\n\n### Rails Console\n\nTo access the Rails console:\n\n```bash\ndocker-compose exec web env DISABLE_SPRING=true bundle exec rails console\n```\n\nAlternatively, you can open a shell inside the container to run commands:\n\n```bash\ndocker-compose exec web bash\n```\n\nFollow along via [Github Issues](https://github.com/datacite/lupo/issues).\n\n### Note on Patches/Pull Requests\n\n- Fork the project.\n- Write tests for your new feature or a test that reproduces a bug.\n- Implement your feature or make a bug fix.\n- Do not mess with Rakefile, version or history.\n- Commit, push and make a pull request. Bonus points for topical branches.\n\n## License\n\n**Lupo** is released under the [MIT License](https://github.com/datacite/lupo/blob/master/LICENSE).\n","funding_links":[],"categories":["Ruby","graphql"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatacite%2Flupo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatacite%2Flupo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatacite%2Flupo/lists"}