{"id":20373388,"url":"https://github.com/arxiver/watch-site","last_synced_at":"2026-04-14T14:32:55.954Z","repository":{"id":176992676,"uuid":"658122252","full_name":"arxiver/watch-site","owner":"arxiver","description":"Watch site is an uptime monitoring RESTful API server that allows authenticated users to monitor URLs, and get detailed uptime reports about their availability, average response time, and total uptime/downtime built using NestJs","archived":false,"fork":false,"pushed_at":"2023-11-01T10:45:14.000Z","size":732,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-21T15:26:19.674Z","etag":null,"topics":["authentication","authorization","backend","javascript","jwt","mongodb","monitoring","nest","nestjs","nestjs-backend","scheduler","schudler","typeorm","typescript","watch","watchdog"],"latest_commit_sha":null,"homepage":"https://localhost:3000","language":"TypeScript","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/arxiver.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"roadmap":null,"authors":null}},"created_at":"2023-06-24T20:53:03.000Z","updated_at":"2023-12-31T14:55:11.000Z","dependencies_parsed_at":"2023-12-31T18:25:11.570Z","dependency_job_id":"22e69b0f-b0d0-45b2-a9e9-c1248e2e277a","html_url":"https://github.com/arxiver/watch-site","commit_stats":null,"previous_names":["rrrokhtar/watch-site","arxiver/watch-site"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/arxiver/watch-site","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arxiver%2Fwatch-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arxiver%2Fwatch-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arxiver%2Fwatch-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arxiver%2Fwatch-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arxiver","download_url":"https://codeload.github.com/arxiver/watch-site/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arxiver%2Fwatch-site/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31801376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["authentication","authorization","backend","javascript","jwt","mongodb","monitoring","nest","nestjs","nestjs-backend","scheduler","schudler","typeorm","typescript","watch","watchdog"],"created_at":"2024-11-15T01:18:08.131Z","updated_at":"2026-04-14T14:32:55.932Z","avatar_url":"https://github.com/arxiver.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Watch-site\n Watch site is an uptime monitoring RESTful API server that allows authenticated users to monitor URLs, and get detailed uptime reports about their availability, average response time, and total uptime/downtime in a given period of time.\n\n\n\u003c!-- \n- Functions documentations:\n```ts\n/** Does something interesting\n* \n* @param Place $where Where something interesting takes place\n* @param integer $repeat How many times something interesting should happen\n*\n* @throws Some_Exception_Class If something interesting cannot happen\n* @return Status\n*/\n``` --\u003e\n\n### Context:\n\n- [x] Signup with email verification. \n- [x] CRUD operations for URL checks (`GET`, `PUT` and `DELETE` can be called only by the user user who created the check). \n- [x] Authenticated users can receive a notification whenever one of their URLs goes down or up again:\n  - [x] Email.\n  - [x] Webhook *(optional)*.\n- [x] Authenticated users can get detailed uptime reports about their URLs availability, average response time, and total uptime/downtime.\n\n**VISIT: [TASK.md](./TASK.md) FOR MORE DETAILS**\n\n## System design diagram\n\n![system-design](./assets/design.png)\n\n## API\n\n![api-docs](./assets/api.png)\n\n\u003chr/\u003e\n\n\n**VISIT: [API.md](./API.md) FOR MORE DETAILS**\n\n\n## Installation\n\n```bash\n$ npm install --legacy-peer-deps\n```\n\n### Database Setup\n1. Make sure you are having mongodb installed on your machine or in cloud \u0026 running server.\n2. Configure the mongodb connection string in `config/env/dev.env` file.\n\nMake sure to configure all the environment variables in `config/env/dev.env` file.\n\n## Running the app\n\n```bash\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n\n# production mode\n$ npm run start:prod\n```\n\n## Test\n\n#### Tests are not yet implemented but the test strategy is as follows:\n- Unit tests for all the services and controllers.\n- Create a mock-server for testing the DOWNS/UPS notifications.\n\n```bash\n# unit tests\n$ npm run test\n\n# test coverage\n$ npm run test:cov\n```\n\n## Stack\n\n- Backend Framework: NodeJS (v18)\n- Language: TypeScript\n- Server Framework: NestJS\n- Database: Mongodb\n- Testing Framework: JestJS\n- API Documentation: Swagger\n\n\n## TODO\n\n- [ ] Dockerization\n- [ ] unit testing\n- [ ] e2e testing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farxiver%2Fwatch-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farxiver%2Fwatch-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farxiver%2Fwatch-site/lists"}