{"id":26905191,"url":"https://github.com/jimdo/serverless-dotenv","last_synced_at":"2025-04-01T10:56:26.231Z","repository":{"id":19050458,"uuid":"85855083","full_name":"Jimdo/serverless-dotenv","owner":"Jimdo","description":"⚡️ Serverless Framework Plugin - Fetch environment variables and write it to a .env file","archived":false,"fork":false,"pushed_at":"2023-04-29T09:18:18.000Z","size":322,"stargazers_count":14,"open_issues_count":18,"forks_count":11,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-14T19:44:14.399Z","etag":null,"topics":["aws","owner-team-creator","serverless","serverless-framework","serverless-plugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@jimdo/serverless-dotenv","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/Jimdo.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-22T17:08:42.000Z","updated_at":"2024-06-20T02:58:50.413Z","dependencies_parsed_at":"2024-06-20T02:58:41.726Z","dependency_job_id":"ba9b17c9-fb3c-4690-9f93-08728d46fc3d","html_url":"https://github.com/Jimdo/serverless-dotenv","commit_stats":{"total_commits":5,"total_committers":2,"mean_commits":2.5,"dds":"0.19999999999999996","last_synced_commit":"e7ad9392bdd0f051dd775562da688534377233b0"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fserverless-dotenv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fserverless-dotenv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fserverless-dotenv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fserverless-dotenv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jimdo","download_url":"https://codeload.github.com/Jimdo/serverless-dotenv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246628262,"owners_count":20808106,"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","owner-team-creator","serverless","serverless-framework","serverless-plugin"],"created_at":"2025-04-01T10:56:25.778Z","updated_at":"2025-04-01T10:56:26.224Z","avatar_url":"https://github.com/Jimdo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⚡️ Serverless Plugin Dotenv\n\n[![npm](https://img.shields.io/npm/v/@jimdo/serverless-dotenv.svg)](https://www.npmjs.com/package/@jimdo/serverless-dotenv)\n[![license](https://img.shields.io/github/license/jimdo/serverless-dotenv.svg)](https://github.com/jimdo/serverless-dotenv/blob/master/LICENSE)\n[![Coveralls](https://img.shields.io/coveralls/jimdo/serverless-dotenv.svg)](https://coveralls.io/github/jimdo/serverless-dotenv)\n\n## About the plugin\n\nThis serverless plugin generates a `.env` file based on the environment variables in the `serverless.yml`. The idea is to use this environment variables for further tasks like integration tests etc. It works great with `serverless offline`, so you can start serverless offline, the plugin will hook into the process and create the `.env` file. You will find the `.env` file in the `.serverless` folder of your project.\n\nIt will collect the global environment variables of the poject as well as all environment variables of the functions. It will also add `API_ENDPOINT` and `IS_OFFLINE` to your environment if you run the plugin via `serverless offline`.\n\n## Usage\n\nAdd the npm package to your project:\n\n```bash\n# Via yarn\n$ yarn add @jimdo/serverless-dotenv\n\n# Via npm\n$ npm instal @jimdo/serverless-dotenv --save\n```\n\nAdd the plugin to your `serverless.yml`:\n\n```yaml\nplugins:\n  - '@jimdo/serverless-dotenv'\n```\n\nThat's it! You can now type `serverless dotenv` in your terminal to generate the `.env` file based on your serverless configuration. Alternative you can just start `serverless offline` to generate it.\n\n## Contribution\n\nFeel free to contribute to this project! Our JavaScript is written based on [standardJS](https://standardjs.com). We recommend to use a `standardJS` [plugin](https://standardjs.com/index.html#are-there-text-editor-plugins) for your Editor, but you can also lint your code with `yarn run lint` - respectively `npm run lint`. Please don't forget to add unit and/or integration tests. Thanks \u003c3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimdo%2Fserverless-dotenv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimdo%2Fserverless-dotenv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimdo%2Fserverless-dotenv/lists"}