{"id":22136610,"url":"https://github.com/shieldfy/serverless-nodejs-starter-template","last_synced_at":"2025-07-25T20:32:59.930Z","repository":{"id":44043082,"uuid":"221394768","full_name":"shieldfy/serverless-nodejs-starter-template","owner":"shieldfy","description":"A boilerplate for new Serverless Nodejs projects with tests and basic configurations","archived":false,"fork":false,"pushed_at":"2023-01-09T22:33:35.000Z","size":2077,"stargazers_count":12,"open_issues_count":16,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-03-22T14:49:26.120Z","etag":null,"topics":["aws-lambda","lambda","nodejs","serverless"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shieldfy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-13T07:06:48.000Z","updated_at":"2022-10-15T12:55:04.000Z","dependencies_parsed_at":"2023-02-08T15:16:19.482Z","dependency_job_id":null,"html_url":"https://github.com/shieldfy/serverless-nodejs-starter-template","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shieldfy%2Fserverless-nodejs-starter-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shieldfy%2Fserverless-nodejs-starter-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shieldfy%2Fserverless-nodejs-starter-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shieldfy%2Fserverless-nodejs-starter-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shieldfy","download_url":"https://codeload.github.com/shieldfy/serverless-nodejs-starter-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227616616,"owners_count":17794254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-lambda","lambda","nodejs","serverless"],"created_at":"2024-12-01T19:24:00.458Z","updated_at":"2024-12-01T19:24:01.276Z","avatar_url":"https://github.com/shieldfy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# serverless-nodejs-starter-template\nA boilerplate for new Serverless Nodejs projects with tests and basic configurations\n\n\n## Description\nSimple hello function take name and return with hello\n\n\n``` javascript\nconst hello = require('./lib/hello');\nconst response = require('./lib/response');\n\nconst helloFn = async (event) =\u003e {\n   \n    let body = event.body ? JSON.parse(event.body) : event; //api gateway (event.body) vs invoke (event)\n    \n    let result = hello(body);\n    \n    return response(result);\n}\n\nmodule.exports.hello = helloFn\n```\n\n## features\n* Ready to use default configuration for serverless framework\n* Environment variables ready with develop, staging and production\n* Works with both invoke and api\n* Serverless offline to test the api gateway localy\n\n## Installation\n\n* Install \u0026 Configure serverless framework, Guide [here](https://serverless.com/framework/docs/getting-started/)\n\n* Clone this repo and run `npm install` then `npm run config`\n\n\n## Test locally\n\n* `npm run local` will run the function directly without serverless framework for fast test on your local machine\n* `npm run invoke` will invoke the function locally and pass the data in `test-data.json` to your function as body\n* `npm run api` will run api gateway locally in your machine on port `3000` so you can test the function as it on AWS api gateway\n\n## Deploy\n* `npm run deploy` will deploy on production and load your .env.production environment variables\n* `npm run deploy-develop` will deploy on develop and load your .env.production environment variables\n* `npm run deploy-staging` will deploy on staging and load your .env.production environment variables\n\n\n\n## Contribution\n\nFeel free to fork, commit and submit pull request if you find a bug, or you want to add support to a new environment. Contributions are very welcome.\n\n## License\n\nMIT\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshieldfy%2Fserverless-nodejs-starter-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshieldfy%2Fserverless-nodejs-starter-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshieldfy%2Fserverless-nodejs-starter-template/lists"}