Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wenderjean/checkdotenv
Verify environment variables presence for Node JS.
https://github.com/wenderjean/checkdotenv
checker dotenv env environment-variables
Last synced: 2 months ago
JSON representation
Verify environment variables presence for Node JS.
- Host: GitHub
- URL: https://github.com/wenderjean/checkdotenv
- Owner: wenderjean
- License: mit
- Created: 2016-11-30T12:24:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-03T04:15:30.000Z (over 7 years ago)
- Last Synced: 2024-10-11T09:24:21.933Z (2 months ago)
- Topics: checker, dotenv, env, environment-variables
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `checkdotenv`
[![npm version](https://badge.fury.io/js/checkdotenv.svg)](https://www.npmjs.com/package/checkdotenv)
[![Dependency Status](https://gemnasium.com/badges/github.com/wenderjean/checkdotenv.svg)](https://gemnasium.com/github.com/wenderjean/checkdotenv)
[![Build Status](https://semaphoreci.com/api/v1/wjsf/checkdotenv/branches/master/badge.svg)](https://semaphoreci.com/wjsf/checkdotenv)It's a project intended to verify if all environment variables previously wrote in the recipe are already set in `process.env`.
## Dependencies
```bash
Node 6.4.0+
```## Install
```bash
npm install checkdotenv --save
```## Usage
First, define a file `.env.example` in your project root and then put the line below in top the entry file of your application.
```bash
require('checkdotenv').check();
```## Options
By default `checkdotenv` will looking for a recipe called `.env.example` but `check` method may receive a parameter to change that filename.
```bash
require('checkdotenv').check('yourfilename');
```## Test
```bash
npm run test
```