{"id":39497276,"url":"https://github.com/clarin-eric/fcs-endpoint-archetype","last_synced_at":"2026-01-18T05:44:14.548Z","repository":{"id":182394842,"uuid":"668426989","full_name":"clarin-eric/fcs-endpoint-archetype","owner":"clarin-eric","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-28T14:31:49.000Z","size":41,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-09-10T03:14:17.115Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clarin-eric.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-19T19:27:49.000Z","updated_at":"2024-10-28T14:31:52.000Z","dependencies_parsed_at":"2023-11-20T10:38:36.082Z","dependency_job_id":"caa10e30-aebb-40d3-aa37-bc1431cb12a8","html_url":"https://github.com/clarin-eric/fcs-endpoint-archetype","commit_stats":null,"previous_names":["clarin-eric/fcs-endpoint-archetype"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/clarin-eric/fcs-endpoint-archetype","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-endpoint-archetype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-endpoint-archetype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-endpoint-archetype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-endpoint-archetype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clarin-eric","download_url":"https://codeload.github.com/clarin-eric/fcs-endpoint-archetype/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-endpoint-archetype/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28531379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-01-18T05:43:28.323Z","updated_at":"2026-01-18T05:44:14.539Z","avatar_url":"https://github.com/clarin-eric.png","language":"Java","funding_links":[],"categories":["Reference Implementations for SRU / FCS"],"sub_categories":[],"readme":"# CLARIN SRU/FCS Endpoint Archetype\n\nThe easiest way to use this archetype is by cloning this git repository, installing the archetype in your local maven repository and then generating your project. But you can also configure your maven to use custom remote repositories if you need to generate projects in the future again.\n\n## (a) Install into Local Maven Repository\n\n```bash\n# optionally run before\n#git clone https://github.com/clarin-eric/fcs-endpoint-archetype.git\n#cd fcs-endpoint-archetype\n\nmvn clean install \"archetype:update-local-catalog\"\n```\n\n## (b) Using the remote CLARIN Maven Repository/Nexus\n\nWith a custom repository, you need to update your local maven settings (can be found at `~/.m2/settings.xml`) to include the CLARIN Nexus for archetype discovery and download.\n\n```xml\n\u003csettings xmlns=\"http://maven.apache.org/SETTINGS/1.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n  xsi:schemaLocation=\"http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd\"\u003e\n  ...\n  \u003cprofiles\u003e\n    \u003cprofile\u003e\n      \u003c!-- id for our custom profile (not active by default) --\u003e\n      \u003cid\u003eclarin\u003c/id\u003e\n      ...\n      \u003crepositories\u003e\n        \u003crepository\u003e\n          \u003cid\u003eCLARIN-Snapshot\u003c/id\u003e\n          \u003curl\u003ehttps://nexus.clarin.eu/content/repositories/clarin-snapshot\u003c/url\u003e\n        \u003c/repository\u003e\n        \u003crepository\u003e\n          \u003cid\u003eCLARIN\u003c/id\u003e\n          \u003curl\u003ehttps://nexus.clarin.eu/content/repositories/Clarin\u003c/url\u003e\n        \u003c/repository\u003e\n        \u003c!-- add repository for archetypes --\u003e\n        \u003crepository\u003e\n          \u003cid\u003earchetype\u003c/id\u003e\n          \u003curl\u003ehttps://nexus.clarin.eu/content/repositories/Clarin\u003c/url\u003e\n        \u003c/repository\u003e\n      \u003c/repositories\u003e\n      ...\n    \u003c/profile\u003e\n  \u003c/profiles\u003e\n  ...\n\u003c/settings\u003e\n```\n\nSee:\n* https://maven.apache.org/settings.html#repositories\n* https://maven.apache.org/archetype/maven-archetype-plugin/generate-mojo.html#archetypeCatalog\n\n## Create a new FCS Endpoint Project\n\nNow that your Maven can find the archetype definition, you can start the project generation:\n\n```bash\nmvn archetype:generate \\\n    -Pclarin \\\n    -DarchetypeGroupId=eu.clarin.sru.fcs \\\n    -DarchetypeArtifactId=fcs-endpoint-archetype \\\n    -DarchetypeVersion=1.6.0 \\\n    -DgroupId=[ id.group.fcs ] \\\n    -DartifactId=[ my-cool-endpoint ] \\\n    -Dversion=[ 1.0-SNAPSHOT ] \\\n    -DinstitutionName=[ My Institution ]\n```\n\nThe values for `artifactIdCamelCase` and `package` are used internally and should be kept as is. The Parameter `classnamePrefix` will be used as prefix for the generated class names: `classnameEndpointSearchEngine`, `classnameSRUSearchResultSet` and `classnameConstants`.\n\nWe use `-Pclarin` to select our `clarin` profile where the archetype repository is defined (to force select our remote repository instead of `central`).\n\nNote that depending on the [`\u003cversion\u003e` in `pom.xml`](pom.xml) and how you installed the Maven repository you should use `-DarchetypeVersion=1.6.0` or `-DarchetypeVersion=1.6.0-SNAPSHOT`!\n\n---\n\n## Update Archetype and Test\n\nInstall into [local repository](#install-into-local-maven-repository), and then test:\n\n```bash\nmvn archetype:generate \\\n    -DarchetypeGroupId=eu.clarin.sru.fcs \\\n    -DarchetypeArtifactId=fcs-endpoint-archetype \\\n    -DarchetypeVersion=1.6.0-SNAPSHOT \\\n    -DarchetypeCatalog=local \\\n    ...\n```\n\n### Install to Remote Repository (_only CLARIN developers_)\n\nCheck that the [`pom.xml`](pom.xml) contains the `\u003cdistributionManagement\u003e` section, and that the matching repository id is configured in the global `~/.m2/settings.xml` file as `\u003cservers\u003e\u003cserver\u003e`. Then upload your artifact by running:\n\n```bash\nmvn deploy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarin-eric%2Ffcs-endpoint-archetype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclarin-eric%2Ffcs-endpoint-archetype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarin-eric%2Ffcs-endpoint-archetype/lists"}