Actor picture

Example using GitHub Gist

apify/example-github-gist

Example of an Apify actor with source code hosted in a GitHub Gist. For example, this is useful if you want to have public code examples accompanied by a working API that anyone can try straight away.

This is an example of an Apify actor that is stored as GitHub Gist. Gists are useful if your actor has multiple source code files but you don't want to create a full Git repository for it or don't want to host your source files directly on Apify. All files of this Gist are provided under Apache 2.0 license.

Whenever you edit the Gist, you'll need to rebuild the actor.

Are you missing anything? Something not clear? Please let us know at support@apify.com

actor-in-gist-example.js

Contains the source code of the actor in Node.js.

package.json

The file used by NPM to maintain metadata about the package, such as list of dependencies. See NPM docs for more details.

Dockerfile

Contains instructions for Docker how to build the image for the act. For more information, see Dockerfile reference.

README.md

The Markup file is used to generate a long description of the actor that is displayed in Apify Library.