A Serverless face rekognition API to be used in order to validate users. Working with face-rekongnition technology from AWS services
. It supports:
- ES7 syntax in your handler functions
- Use
import
andexport
- Use
- Package your functions using Webpack
- Run API Gateway locally
- Use
serverless offline start
- Use
- Support for unit tests
- Run
npm test
to run your tests
- Run
- Sourcemaps for proper error messages
- Error message show the correct line numbers
- Works in production with CloudWatch
- Automatic support for multiple handler files
- No need to add a new entry to your
webpack.config.js
- No need to add a new entry to your
- Add environment variables for your stages
To create a new face-rekon project.
$ git clone https://github.com/mendoza-com/face-rekognition.git
Enter the new directory
$ cd face-rekongnition
Install the Node.js packages
$ npm install
To run unit tests on your local
$ npm test
To run a function on your local
$ serverless invoke local --function hello
To simulate API Gateway locally using serverless-offline
$ serverless offline start
Run your tests
$ npm test
We use Jest to run our tests. You can read more about setting up your tests here.
Deploy your project
$ serverless deploy
Deploy a single function
$ serverless deploy function --function hello
To add another function as a new file to your project, simply add the new file and add the reference to serverless.yml
. The webpack.config.js
automatically handles functions in different files.
To add environment variables to your project
- Rename
env.example
toenv.yml
. - Add environment variables for the various stages to
env.yml
. - Uncomment
environment: ${file(env.yml):${self:provider.stage}}
in theserverless.yml
. - Make sure to not commit your
env.yml
.