Serverlessify Backend Starter Kit
A production ready node API backend organized in Serverless projects and served by an Express server as if it was on AWS. The starter kit provide:
- Auth0 authorizer with default url structure check
- Local DynamoDB auto-generation for testing
- Dockerfile ready for production artifact generation
- CLI interface template to use and integration test developed APIs
- Unit test ready
- Devtool support
Install dependencies and run the dev server:
npm install
npm start
You should see the database started and prepared for usage as well as the endpoints exposed by the backend.
Use help
with any command (like npm start help
) to see available options.
Command options are specified with columns like npm run image release tag:latest
.
Check the Serverlessify documentation to see how the server is started. Refer to readmes in the Serverless projects for endpoint specific documentation.
To create a new sub-project do this:
-
Create a folder in the
src
-
Indie that folder use
serverless create -t aws-nodejs
-
Edit the created
serverless.yml
to your liking, see the example-user service to see how to add DynamoDB tables, fixtures and endpoints -
Add the new Serverless project to the
server.js
file like so:sls( require('../my-project/serverless.yml'), { handler: require('../my-project/handler.js') } );
-
Start the server and see you new enpoints being served
More useful documentation is: