{"id":25081168,"url":"https://github.com/neonarray/clue-server","last_synced_at":"2026-04-28T12:37:12.303Z","repository":{"id":152360374,"uuid":"165727068","full_name":"NeonArray/clue-server","owner":"NeonArray","description":"The server counter-part for the Clue WordPress plugin","archived":false,"fork":false,"pushed_at":"2019-01-14T20:27:28.000Z","size":476,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-30T01:47:01.040Z","etag":null,"topics":["express","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NeonArray.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-01-14T20:06:43.000Z","updated_at":"2019-01-14T20:27:29.000Z","dependencies_parsed_at":"2023-05-01T08:27:43.415Z","dependency_job_id":null,"html_url":"https://github.com/NeonArray/clue-server","commit_stats":null,"previous_names":["neonarray/clue-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NeonArray/clue-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeonArray%2Fclue-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeonArray%2Fclue-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeonArray%2Fclue-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeonArray%2Fclue-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NeonArray","download_url":"https://codeload.github.com/NeonArray/clue-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeonArray%2Fclue-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262944691,"owners_count":23388807,"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":["express","nodejs"],"created_at":"2025-02-07T04:37:09.235Z","updated_at":"2026-04-28T12:37:07.271Z","avatar_url":"https://github.com/NeonArray.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \"Clue\" Server\n\nThis node server is part of the larger \"Clue\" app, which is an [event logger for WordPress](https://github.com/ocularrhythm/clue-client). I believe that this server is partially incomplete, but should be functional in its current state.\n\nAs of writing this, I have not touched the code in this app in over a year so I am somewhat fuzzy on some of the details. However, I built this wholly aware that I wanted to \"set and forget,\" so should be easy to reason about if given a little time to read through the code. \n\nThe tools used for this app are:\n- Node v9.10.1\n- Express\n- MongoDB with Mongoose\n- Mocha/Chai for testing with NYC for coverage reporting\n- eslint for quality\n\n[The generated docs for the API can be found here.](https://ocularrhythm.github.io/clue-server/)\n\n## Getting Started\n\nClone the repository and install dependencies:\n```bash\nyarn install\n```\n\nInstall LocalTunnel in order to expose your local environment to the web:\n```bash\nyarn add localtunnel -G\n```\n\nNext, boot up mongodb and run the server:\n```bash\nmongod\nyarn start\n```\n\nLastly start localtunnel with a subdomain of \"clue\" (to make things easier) and port of `3000`:\n```bash\nlt -S \"clue\" -p 3000\n```\n\nTest everything works by sending a request for all events:\n```bash\ncurl https://clue.localtunnel.me/api/v1/event\n```\n\nYou should have received:\n```json\n{\"status\":401,\"message\":\"\"}\n```\n\n\n## API Documentation\n\nThe documentation is generated using the `api-doc-generator` package. [The output](./docs/index.html) for this is put into the `docs` directory. \n\n\n## Testing\n\nThe test harness utilized for unit tests is `mocha` and `chai`. Code coverage is generated using `nyc`. \n\nYou will need to have an instance of `mongo` running, prior to invoking the tests.\n\nTo run the tests:\n```bash\nsudo mongod\nyarn test\n```\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneonarray%2Fclue-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneonarray%2Fclue-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneonarray%2Fclue-server/lists"}