{"id":25301609,"url":"https://github.com/snvfk1n/simple-annotation-server","last_synced_at":"2026-01-20T05:02:05.715Z","repository":{"id":48041006,"uuid":"276102880","full_name":"snvfk1n/simple-annotation-server","owner":"snvfk1n","description":"💭 Simple HTTP server that implements the Web Annotation specification","archived":false,"fork":false,"pushed_at":"2021-08-10T10:29:37.000Z","size":175,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-22T11:45:56.362Z","etag":null,"topics":["annotation","linked-data","web-annotation"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/snvfk1n.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}},"created_at":"2020-06-30T13:13:28.000Z","updated_at":"2025-01-23T14:45:13.000Z","dependencies_parsed_at":"2022-07-22T00:46:54.450Z","dependency_job_id":null,"html_url":"https://github.com/snvfk1n/simple-annotation-server","commit_stats":null,"previous_names":["snvfk1n/simple-annotation-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/snvfk1n/simple-annotation-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snvfk1n%2Fsimple-annotation-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snvfk1n%2Fsimple-annotation-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snvfk1n%2Fsimple-annotation-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snvfk1n%2Fsimple-annotation-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snvfk1n","download_url":"https://codeload.github.com/snvfk1n/simple-annotation-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snvfk1n%2Fsimple-annotation-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28596087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["annotation","linked-data","web-annotation"],"created_at":"2025-02-13T06:46:29.554Z","updated_at":"2026-01-20T05:02:05.699Z","avatar_url":"https://github.com/snvfk1n.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simple Annotation Server\n\nThis is a very simple annotation server intended for testing purposes, implementing both the [Web Annotation Protocol](https://www.w3.org/TR/annotation-protocol/) as well as the [Web Annotation Data Model](https://www.w3.org/TR/annotation-model/) with simple REST-based user management. The server is written in JavaScript and runs in [Node.js](https://nodejs.org/en/), running an in-process LevelDB database.\n\nThe server is in active development and its API is subject to frequent change.\n\n\n### Usage\n\nWith a recent version of Node.js installed (`v12` should be sufficient), install all dependencies via `npm install`. Then, start the annotation server via `./bin/server.js index.js`—3000 will be its default port. With each start, the annotation server will generate a new, random API token which will be reported in its terminal output during startup.\n\n#### Creating Users\n\nWe'll be using `curl` to access the annotation server's JSON API. To create new user, run the following command, specifying the API token either via GET parameters (`access_token`) or via HTTP bearer authentication:\n\n```bash\ncurl -XPOST \\\n  -H 'content-type: application/json' \\\n  --data '{\"name\": \"alice\"}' \\\n  \"http://localhost:3000/?access_token=${API_TOKEN}\"\n```\n\nIn its HTTP response, the server will return a new, random password for that user. We can verify the creation via:\n\n```bash\ncurl --user alice:${PASSWORD} http://localhost:3000/alice\n```\n\n#### Creating Collections\n\nWith the newly created user and the assigned password, we'll create a new annotation collection. A collection corresponds to a [Web Annotation Container](https://www.w3.org/TR/annotation-protocol/#annotation-containers), which is a collection of annotations. Each user can have multiple collections.\n\nTo create such a collection named ‘Notes’ for Alice, run the following command:\n\n```bash\ncurl -XPOST \\\n  --user alice:${PASSWORD} \\\n  -H 'content-type: application/json' \\\n  --data '{\"name\": \"notes\"}' \\\n  http://localhost:3000/alice\n```\n\nThe newly created collection will then be available under her profile:\n\n```bash\ncurl --user alice:${PASSWORD} http://localhost:3000/alice\n```\n\nMore TBD.\n\n\n### API Documentation\n\nTBD.\n\n\n### License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnvfk1n%2Fsimple-annotation-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnvfk1n%2Fsimple-annotation-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnvfk1n%2Fsimple-annotation-server/lists"}