{"id":42852110,"url":"https://github.com/dnj/web-shot","last_synced_at":"2026-01-30T12:07:43.171Z","repository":{"id":177953459,"uuid":"661139364","full_name":"dnj/web-shot","owner":"dnj","description":"Web-Shot is a high-performance online screenshot service that lets you capture any webpage.","archived":false,"fork":false,"pushed_at":"2024-04-07T12:37:48.000Z","size":3862,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-07T14:59:50.284Z","etag":null,"topics":["nuxtjs","screenshot"],"latest_commit_sha":null,"homepage":"https://web-shot.ir","language":"TypeScript","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/dnj.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}},"created_at":"2023-07-01T23:04:19.000Z","updated_at":"2024-04-14T16:52:44.230Z","dependencies_parsed_at":null,"dependency_job_id":"67e489fb-5ab8-4c92-8b3e-8f4aba8ecac6","html_url":"https://github.com/dnj/web-shot","commit_stats":null,"previous_names":["dnj/web-shot"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dnj/web-shot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnj%2Fweb-shot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnj%2Fweb-shot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnj%2Fweb-shot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnj%2Fweb-shot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dnj","download_url":"https://codeload.github.com/dnj/web-shot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dnj%2Fweb-shot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28912311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T11:55:24.701Z","status":"ssl_error","status_checked_at":"2026-01-30T11:54:13.194Z","response_time":66,"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":["nuxtjs","screenshot"],"created_at":"2026-01-30T12:07:42.498Z","updated_at":"2026-01-30T12:07:43.165Z","avatar_url":"https://github.com/dnj.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Web-Shot:  A Blazing Fast Screenshot Service\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"assets/images/logo.png\"\u003e\n\u003c/p\u003e\n\nWeb-Shot is a high-performance online screenshot service that lets you capture any webpage with ease. \n\n### Features\n\n* **Lightning Speed:** Capture webpages in a flash thanks to the power of Google Chrome.\n* **Flexible API:** Integrate Web-Shot seamlessly into your applications with a well-documented API.  For detailed API specifications, refer to the [OpenAPI 3.0 document](openapi.yaml)\n* **Simple UI:** For those who prefer a point-and-click approach, Web-Shot offers a user-friendly interface. \n* **Tech Stack:** Built with modern technologies like Nuxt.js, Prisma, and TypeScript for a robust and maintainable codebase.\n* **Deployment Options:** Deploy Web-Shot on your server or leverage the convenience of Docker images.\n* **Open Source \u0026 MIT Licensed:** Contribute to the project and use it in your own projects freely under the permissive MIT license.\n\n### Requirements\n\n* Node.js \u003e= 20\n* MySQL \u003e= 5.7 or MariaDB \u003e= 10\n\n### Installation\n\n**1. Clone the repository:**\n\n```bash\ngit clone https://github.com/dnj/web-shot\n```\n\n**2. Install dependencies:**\n\n```bash\ncd web-shot\nnpm install\n```\n\n**3. Configure database connection:**\n\nRename `.env.example` to `.env` and configure your database connection details.\nThen you can build Prisma Client:\n\n```bash\nnpx prisma generate\n```\n\nAnd create tables:\n\n```bash\nnpx prisma db push\n```\n\n**4. Run the application:**\n\n```bash\nnpm run dev\n```\n\nThis will start the development server. Access the UI at `http://localhost:3000` by default.\n\n### Usage\n\n**API:**\n\nWeb-Shot offers a simple API for programmatic screenshot capture. The only endpoint currently available is:\n\n* `/capture` (GET): This endpoint captures a screenshot of a specified webpage.\n\nResponse Format:\nThe response will be the captured screenshot in either JPEG or PNG format depending on the request parameters.\n\n**Query Parameters:**\n\n| Name        | Type    | Required | Default Value | Description                                                 |\n|-------------|---------|----------|----------------|-------------------------------------------------------------|\n| url         | string  | Yes      | -             | The URL of the webpage you want to capture.                 |\n| width        | number  | No       | 1200           | The desired width of the final screenshot in pixels.       |\n| height       | number  | No       | 600            | The desired height of the final screenshot in pixels.      |\n| maxAge       | number  | No       | 86400          | Max age in seconds of image if it already cached. Min 10s. |\n| format       | string  | No       | \"jpeg\"         | Image format, possible values: \"jpeg\" or \"png\".            |\n| fullpage     | boolean | No       | false          | Whether to take a screenshot of the full webpage or not.   |\n| viewportWidth | number  | No       | 1200           | The page width in pixel. Min 320, Max 4096.                 |\n| viewportHeight| number  | No       | 600            | The page height in pixel. Min 320, Max 4096.                |\n| timeout     | number  | No       | 10000          | The max time in ms to wait for the page to load. Min 2000, Max 15000. |\n\n\n**UI:**\n\nVisit `http://localhost:3000` to access the user interface for capturing screenshots.\n\n### Docker Deployment\n\nWeb-Shot provides a convenient Docker image for streamlined deployment. This section guides you through getting started with Web-Shot using Docker.\n\n```bash\ndocker pull ghcr.io/dnj/web-shot:2\n```\n\n**Environment Variables:**\n\nWeb-Shot utilizes environment variables for configuration. You can either specify them directly when running the container.\n\nHere are some of the important environment variables:\n\n* `DATABASE_URL`: URL for your database connection (refer to Prisma documentation for format).\n* `PORT`: Port on which the Web-Shot application will listen (defaults to 80).\n\nFor a more detailed configuration using a `.env` file and Docker Compose, refer to the `docker-compose.yaml` file provided in the repository.\n\n### License\n\nWeb-Shot is licensed under the MIT License. See the `LICENSE` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdnj%2Fweb-shot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdnj%2Fweb-shot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdnj%2Fweb-shot/lists"}