README

• README
  • Summary
  • Setup
    • Development container
    • Environment variables
  • Deployment
    • Remove
  • Contribution guidelines
    • Code review
    • Other guidelines
  • Glossary
    • Service environment variables: .envs/config.env
    • Service environment variables: .envs/aws.env
    • Service environment variables: .envs/sls.env
    • Serverless Framework deployment variables

---

Summary

Captcha: repository contains a software stack that allows solve captchas using AWS Textract.

Setup

Development container

This steps are tailored to work with Visual Studio Code, but you are free to chose a different IDE and make necesary adjustments to the setup.

1. Install ms-vscode-remote.remote-containers extension. If you don't know how to do that follow this steps: https://code.visualstudio.com/docs/editor/extension-gallery#_install-an-extension
2. Open this project's folder in Visual Studio Code. The extension will detect a container configuration and will ask you if you want to reopen the project un the container. Accept.

Environment variables

In .envs folder you'll need to create env files with the variables here.

Deployment

You can deploy Cloud Formation Stacks using Serverless Framework syntax: https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy/

Deployment order:

1. Deploy serverless/infrastructure stack
2. Deploy serverless/backend stack

Remove

You must use Serverless Framework remove command as primary option: https://www.serverless.com/framework/docs/providers/aws/cli-reference/remove/

If remove command fails for whatever reason, you'll need to investigate the reason using AWS Console at your browser, solve the issue and then re-attempt the remove command.

You can, alternatively, delete the AWS Cloud Formation stack manually using AWS Console at your browser. But it's recommended to do it using the remove command from Serverless Framework.

Stacks are independent, but still, recommended remove order is inverse to deployment order.

---

Contribution guidelines

Code review

• Use known standards where situation allows it.
• Use known solutions for known problems.

Other guidelines

• Investigate known and proven solutions before manufacturing your own.
• Check if our cloud provider offers a service you could use to solve the problem: evaluate ease of use, costs, maturity and reviews.
• If you need to use a library make sure it's mature, has continous releases, it's stable.
• If a solution starts to get too messy, it's probably not the right solution.

---

Glossary

Service environment variables: .envs/config.env

• DEVELOPER: username

Service environment variables: .envs/aws.env

• AWS_ORGANIZATION_ID
• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_DEFAULT_REGION
• AWS_DEFAULT_OUTPUT

Service environment variables: .envs/sls.env

• SERVERLESS_ACCESS_KEY: Serverless Framework access key

Serverless Framework deployment variables

• stage: Means the deployment stage. Values can be dev, test or prod
• Other deployment options can be set through CLI command. More info here