node-v10.x-aws-serverless

PROJECT-NAME

This project was generated using https://github.com/UnlyEd/boilerplate-generator/tree/master/templates/node-v10.10-aws-serverless

• TODO (after generating a project from this boilerplate)
• Features/defaults provided by this boilerplate
• Getting started
  • Install
  • Use
  • Deploy
  • Logs
  • Test
  • Release
• Features/defaults provided by this boilerplate
• Vulnerability disclosure
• Contributors and maintainers
• [ABOUT UNLY]

TODO (after generating a project from this boilerplate)

• Rename occurrences of PROJECT-NAME
• Look for TODO
  • Use your own AWS profile instead of sandbox
• Enable sentry, if needed (or delete)
  • serverless.yml
  • .sentryclirc
• Delete this

Features/defaults provided by this boilerplate

• SLS handles stages/environments and settings per environment (memorySize, AWS profile, etc.)
  • "staging" and "production" environments built-in
• SLS scripts (helpers)
• Environment variables built-in by default (both from .env* files and serverless.yml), using dotenv and @unly/serverless-env-copy-plugin
• Sentry easy opt-in (disabled by default)
  • Source maps on Sentry for easier debug
  • Automatic error handling on the lambda level through RavenLambdaWrapper.handler (won't do anything if Sentry isn't setup)
• Babel 7
• Webpack 4
• Jest for testing
  • Jest extended https://github.com/jest-community/jest-extended included
  • Support for ENV variables built-in
• Use YARN for packaging
• 30s timeout on lambda (max allowed)
• 128Mo RAM on lambda (min allowed)
• 60 days logs retention (avoid infinite logs and lambda price increase)
• Enable API GW logs by default

Getting started

Clone this boilerplate

See instructions

Install

yarn install

Use

yarn start

Deploy

yarn deploy # Deploy to staging env
NODE_ENV=production yarn deploy # Deploy to production env

Logs

yarn logs:status

Similar to reading the logs from the AWS Console

Test

yarn test
yarn test:coverage

Release

Will prompt version to release, run tests, commit/push commit + tag

yarn release

Check the ./package.json file to see what other utility scripts are available

Vulnerability disclosure

See our policy.

---

Contributors and maintainers

This project is being maintained by:

• [Unly] Ambroise Dhenain (Vadorequest) (active)

---

[ABOUT UNLY]

Unly is a socially responsible company, fighting inequality and facilitating access to higher education. Unly is committed to making education more inclusive, through responsible funding for students. We provide technological solutions to help students find the necessary funding for their studies. We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit :

• https://twitter.com/UnlyEd
• https://www.facebook.com/UnlyEd/
• https://www.linkedin.com/company/unly
• Interested to work with us?

Tech tips and tricks from our CTO on our Medium page!

#TECHFORGOOD #EDUCATIONFORALL