Skip to content

Missing documentation #10

@sbuckpesch

Description

@sbuckpesch

Great boilerplate. Got me starting fast on a bigger project. Unfortunately the docs are not very detailed. A lot of things I needed to research or did not get it yet.

1. Environment variables
How do you manage environment variables? In the webpack config you included .env in the plugin section. As well you include the serverless-kms-secrets plugin. How do you manage that?

2. Workflow
A description of a typical workflow would be helpful. Here is mine.

  1. Create a new project using a template / Ref: https://github.com/nordcloud/serverless-boilerplate
    sls install -u https://github.com/nordcloud/serverless-boilerplate -n myservicename
  2. Create a new function incl. a test and two HTTP endpoints / Ref: https://github.com/nordcloud/serverless-mocha-plugin
    sls create function -f myFunction --handler functions/myFunction/index.handler --httpEvent "post myResource" --httpEvent "get myResource"
  3. Display the logs in a new console / Ref: https://serverless.com/framework/docs/providers/aws/guide/workflow#streaming-logs
    sls logs -f myFunctionName --startTime 10m -t
  4. Invoke a function locally in Debug-Mode using Webpacks watch functionality / Refs: https://serverless.com/framework/docs/providers/aws/cli-reference/invoke#invoke-local https://github.com/serverless-heaven/serverless-webpack#run-a-function-locally-on-source-changes
    SLS_DEBUG=true sls invoke local -f functionName -p functions/calculateMatch/match.json --watch
  5. Deploy
    sls deploy --stage dev

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions