ecg-sam-create

This project is a CLI tool used to generate SAM templates using Electronic Caregiver's serverless standard.

Installation

Prerequisites

• Node.js v10.16.3+

Instructions

• Make sure you have NPM installed. If not, make sure you have Node.js and it's up to date, NPM comes bundled with Node.js. To check if NPM is installed, run this command:

npm -v

• Install ecg-sam-create globally. This will allow you to run the CLI command from any directory. Do not install locally.

npm i -g ecg-sam-create

• You now have the ecg-sam-create tool installed globally in your environment.

How to use

• Navigate to the directory you want your project folder to live and run:

ecg-sam-create -n project-name-here // note: project name must be hyphen-case

• A folder with your project name should now be generated in the current directory.
• cd into that folder, and you should see a folder that also has the same name as your project name. cd into that folder also.
• You should now be in your-project-name/your-project-name. From here, run npm install, this will install all your dependencies.
• Run npm start to spin up the Docker container and run your Lambda code locally.
• You can also run npm test here to run your Jest test suite.

Contributors

• Michael Lyon - [email protected]
• Dustin Charles - [email protected]