[Project devs to add: Add a short description about what this project codebase is.]
[Project devs to add: Add a short description on codebase architecture.]
This project runs in AWS Lambda, using the Node 10 runtime.
The Lambda function can be ran locally via a Docker container.
To run your function, run scripts/console
- Download and install Docker Desktop for Mac.
- Ensure no other applications are using the same ports as the Docker containers in this projects use.
To start the project, run scripts/bootstrap.
If this is the first time checking out the project. The script will create an environment file from the example file, and run any application initialistion scripts.
Use the bootstrap script to start a project in an initialised state.
Usage:: $ scripts/bootstrap [args]
| Argument | Description |
|---|---|
| --no-update | Makes the script skip application dependency installation |
This script creates a .env file if one isn’t present, builds and starts the Docker service containers, installs applications dependencies (Composer packages, Node modules, Database schema, and seeding data), and generates an application key.
Usage:: $ scripts/update
Update installs application dependencies inside app container. For example Composer packages, Node modules, Database schema, and seeding data
Usage: $ scripts/build [command]
Build is used for building/compiling javascript, and running Yarn. If no command is passed, the script will run yarn’s development build task.
Usage: $ scripts/test
Test runs the applications testing suite.
Usage: $ scripts/console [args]
Console runs the local aws lambda. If no command is passed, it will run the handler method in src/index.js