This repository stores boilerplate templates and code examples for Apify Actor. The template helps you to get started with your Apify project quickly.
You can start using them right away in Apify command-line interface:
npm -g install apify-cli apify create my-actor
It displays an interactive list of templates for you to choose from. See Apify CLI documentation for more details.
To run the template:
cd my-actor apify run
The example templates provide a quick and easy way to get to know Apify actors. Just install the CLI and watch your actor run.
You can find more code examples in the examples folder and in the Apify SDK documentation.
If you're already familiar with actors, you can use the following templates to bootstrap new projects quickly:
The template manifest can be fetched programmatically. Apify CLI uses this to always fetch the most up to date templates.
npm i @apify/actor-templates
const templates = require('@apify/actor-templates'); const manifest = await templates.fetchManifest();
All templates are stores in
For each template needs to create an archive of whole source code into
The archive is used to to create a boilerplate template in apify CLI or other places in Apify system.
If you want to change template, you need to update the files and
and then push to master. After pushing to master, the archive will be automatically built using Github actions.
Templates are propagated to Apify CLI templates, you can choose one of the templates when using the
apify create command.
The propagation happens after committing a new version of templates into
master branch. After tests succeeded the Github action
builds archives of each template and pushes these archives into the repository. The CLI command then uses those archives
to bootstrap your project folder. We did it this way because we can update template structure/code without publishing
any package to npm. It makes templates changes agile.
If you have any ideas for improvements, either submit an issue or create a pull request. For contribution guidelines and the code of conduct, see CONTRIBUTING.md.
A manifest of Apify actor templates.
The npm package @apify/actor-templates receives a total of 425 weekly downloads. As such, @apify/actor-templates popularity was classified as not popular.
We found that @apify/actor-templates demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.