Friendship PWA with ES7 syntax, serverless-offline, linting, environment variables, and unit test support. Using Serverless Stack guide.
Uses the serverless-bundle plugin (an extension of the serverless-webpack plugin) and the serverless-offline plugin. It supports:
- Generating optimized Lambda packages with Webpack
- Use ES7 syntax in your handler functions
- Use
import
andexport
- Use
- Run API Gateway locally
- Use
serverless offline start
- Use
- Support for unit tests
- Run
npm test
to run your tests. Jest is the testing framework adopted Reference for mocking with Sinon
- Run
- Sourcemaps for proper error messages
- Error message show the correct line numbers
- Works in production with CloudWatch
- Lint your code with ESLint
- Add environment variables for your stages
- No need to manage Webpack or Babel configs
A demo version of this service is hosted on AWS - https://z6pv80ao4l.execute-api.us-east-1.amazonaws.com/dev/hello
To create a new Serverless project.
$ git clone
Enter the new directory
$ cd friendship-api
Install the Node.js packages
$ npm install
Start PostgreSQL
$ sudo pg_ctlcluster 12 main start
$ sudo -u postgres psql
Change default password:
postgres=# ALTER USER postgres PASSWORD 'postgres';
This api was created based sequelize migrations - ['https://www.serverless.com/plugins/serverless-sequelize-migrations']
Create migration file:
sls --verbose migrations create -n create-note
Run all migrations:
sls --verbose migrations up --stage dev
To run a function on your local
$ serverless invoke local --function hello
To run a mock of a function
$ serverless invoke local --function charge --path mocks/note/charge.json
To simulate API Gateway locally using serverless-offline
$ serverless offline start
Deploy your project
$ serverless deploy
Deploy a single function
$ serverless deploy function --function hello
Run your tests using
$ npm test
We use Jest to run our tests. You can read more about setting up your tests here.
To add environment variables to your project
- Rename
env.example
to.env
. - Add environment variables for your local stage to
.env
. - Uncomment
environment:
block in theserverless.yml
and reference the environment variable as${env:MY_ENV_VAR}
. WhereMY_ENV_VAR
is added to your.env
file. - Make sure to not commit your
.env
.
We use ESLint to lint your code via the serverless-bundle plugin.
You can turn this off by adding the following to your serverless.yml
.
custom:
bundle:
linting: false
To override the default config, add a .eslintrc.json
file. To ignore ESLint for specific files, add it to a .eslintignore
file.
- Open a new issue if you've found a bug or have some suggestions.
- Or submit a pull request!
This repo is maintained by Anomaly Innovations; makers of Seed and Serverless Stack.