{"id":18710757,"url":"https://github.com/apify/actor-quick-start","last_synced_at":"2025-11-03T16:29:55.171Z","repository":{"id":48780004,"uuid":"108544242","full_name":"apify/actor-quick-start","owner":"apify","description":"Contains a boilerplate of an Apify actor to help you get started quickly build your own actors.","archived":false,"fork":false,"pushed_at":"2022-07-25T12:39:52.000Z","size":33,"stargazers_count":15,"open_issues_count":1,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-13T21:53:27.159Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://apify.com/apify/quick-start","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apify.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":"2017-10-27T12:37:29.000Z","updated_at":"2024-04-18T09:08:06.000Z","dependencies_parsed_at":"2022-09-09T20:23:57.297Z","dependency_job_id":null,"html_url":"https://github.com/apify/actor-quick-start","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apify/actor-quick-start","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apify%2Factor-quick-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apify%2Factor-quick-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apify%2Factor-quick-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apify%2Factor-quick-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apify","download_url":"https://codeload.github.com/apify/actor-quick-start/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apify%2Factor-quick-start/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259940961,"owners_count":22935290,"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":[],"created_at":"2024-11-07T12:35:35.828Z","updated_at":"2025-11-03T16:29:55.128Z","avatar_url":"https://github.com/apify.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"This is a simple Apify actor that serves as a basic boilerplate.\nIt has a Node.js source code, custom Dockerfile and it's hosted in a Git repository.\nFeel free to copy this actor, modify it and use it in your own actors.\n\nAre you missing anything? Something not clear? Please let us know at support@apify.com\n\nTo run the actor in your local environment, simply run the following commands:\n\n```bash\nnpm install\nnpm run start\n```\n\nAlternatively, if you have [Apify CLI](https://apify.com/docs/cli) installed, you can start the actor by running:\n\n```bash\napify run\n```\n\nIn order to test the build of the Docker image, you can run:\n\n```\ndocker build ./\n```\n\nOn success, the command will print something like:\n\n```\n...\nRemoving intermediate container 22915a918e4c\nStep 6/6 : CMD node main.js\n ---\u003e Running in 7288f9a12cf0\n ---\u003e 0d82ea8a648d\nRemoving intermediate container 7288f9a12cf0\nSuccessfully built XYZ\n```\n\nAfter that you can run the built Docker image locally using:\n\n```bash\ndocker run XYZ\n```\n\nWhere `XYZ` is ID of the Docker image built in the previous step.\n\nIf there is any problem with the built image, you might try troubleshooting it\nby starting the container in interactive mode using:\n\n```\ndocker run -it XYZ /bin/bash\n```\n\nNote that this requires a base Docker image that contains bash or some other interactive shell.\n\n\n## `.gitignore`\n\nSpecifies files and directories that shouldn't be included in the Git repository.\n\n## `apify.json`\n\nThe file is used by [Apify CLI](https://apify.com/docs/cli)\nand it contains information linking your local source code directory with the\nactor on the Apify platform.\nYou only need this file if you want to run commands such as `apify run`\nor `apify push`.\n\n## `Dockerfile`\n\nContains instructions how to build a Docker image that will contain\nall the code and configuration needed to run your actor.\nFor more information, see [Dockerfile reference](https://docs.docker.com/engine/reference/builder/).\n\n## `INPUT_SCHEMA.json`\n\nDefines schema for the actor input. It is used by the Apify platform\nto automatically check the input for the actor and to generate\na user interface to help users of your actor to run it.\nFor more information, see [Input Schema documentation](https://apify.com/docs/actor/input-schema). \n\n## `main.js`\n\nThe main Node.js source code of your actor.\nIt is referenced from the `scripts` section of the `package.json` file,\nso that it can be started by running `npm start`.\n\n## `package.json`\n\nThe file is used by NPM to maintain metadata about the Node.js source code,\nsuch as the list of dependencies.\nFor details, see [NPM documentation](https://docs.npmjs.com/files/package.json).\n\n## `README.md`\n\nContains a [Markdown](https://www.markdownguide.org/cheat-sheet)\ndocumentation what your actor does and how to use it,\nwhich is then displayed in the app or [library](https://apify.com/apify/quick-start).\nIt's always a good idea to write a good README.md, in a few months not even you\nwill remember all the details about the actor.\n\n## `apify_storage`\n\nThis directory contains data from\n[Apify SDK storages](https://sdk.apify.com/docs/guides/data-storage)\nduring local development, such as the key-value stores,\ndatasets and request queues.\nTypically you don't want to have the `apify_storage` directory in Git repo,\nbut in this boilerplate we keep the `INPUT.json` file in Git\nfor documentation purposes.\n\nWhen running the actor on the Apify platform, the actor is automatically assigned\na key-value store that is used to store actor's input, output or any other data.\nThe `apify_storage/key_value_stores/default` directory is used to emulate this store\nduring the local development of your actor.\nThe files in the directory represent the records in the key-value store: the name\nof each file corresponds to its key and the content to the value.\n\nFor example, calling `Apify.getValue('INPUT')` will return the content\nof the `apify_storage/key_value_stores/default/INPUT.json` file parsed as JSON. Similarly, calling\n`Apify.setValue('OUTPUT', ...)` will write a file to `apify_storage/key_value_stores/default/OUTPUT.json`.\n\nFor more information, see the [Getting Started](https://sdk.apify.com/docs/guides/getting-started) tutorial\nof the [Apify SDK](https://sdk.apify.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapify%2Factor-quick-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapify%2Factor-quick-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapify%2Factor-quick-start/lists"}