/altostra-template-s3-file-processing-nodejs

This template provides the basis for processing files added to an S3 bucket using the Claim Check pattern.

Primary LanguageJavaScriptMIT LicenseMIT

S3 File Processing Template - Node.js

This template provides the basis for processing files added to an S3 bucket using the Claim Check pattern.

Before you begin

1. Create a free Altostra account

Go to app.altostra.com to sign up for a free account.

2. Connect an AWS account

If you haven't connected an AWS account during sign up, you can do it on the Cloud Integrations page.

An AWS account is required to deploy projects.

3. Install the Altostra CLI

$ npm install -g @altostra/cli

Using the template

  1. Go to projects.
  2. Click Create Project.
  3. Enter a project name and select s3-file-processing-nodejs from the list of templates.
  4. Use the Clone button on the project page to obtain the Git repository URL after the project is created.
  5. Clone the Git repository to you local machine.

Deploying the project

Login to your account from the Altostra CLI:

$ alto login

Deploy a new project stack:

# run in the project dir
$ alto deploy prod --push --env

The --push option will auto-create a version.
The --env option will prompt you to select an environment from a list.

See the Altostra CLI documentation for all available commands and options.

Stack deployment status and details

From the CLI:

# list the stacks for the current project
$ alto stacks

# show details for the "prod" stack
$ alto stacks get prod

From the Web Console:

# open the current project page in Web Console
$ alto console

Modifying the project

Modify the project using the Altostra extension for Visual Studio Code.
The extension is available on the Visual Studio marketplace.

To install the extension, search for Altostra in the Extensions view in Visual Studio Code.

Or, install it from the terminal:

$ code --install-extension Altostra.altostra

Template content

Source files

The Lambda functions source files are located in the functions directory.

Contact

Submit issues and pull requests directly to this repository. You contribution is appreciated.

If you need further assistance, have questions or suggestions, you can reach us at support@altostra.com.