@calvear/demo-env

env

¡Environment variables handler made easy!

       

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

📖 About

The aim of this library is ease NodeJS environment variable handling, like env-cmd or dotenv, but with powerfull features and extensibility for adding custom providers (as plugins) for load, pull and push the variables from different stores.

(back to top)

⚡️ Quick start

npm install @calvear/env

🔔 Make sure that you have NodeJS 14+ installed on your computer.

(back to top)

📌 Requirements

First, download and install NodeJS. Version 14 or higher is required.

Validate installed versions of node and npm with:

> node -v
v16.14.2

> npm -v
8.3.0

You can initialize a new npm project using:

> npm init

(back to top)

⚙️ Commands & Options

[>_] env

Load your environment variables into a subcommand.

env [OPTION]

Option	Description	Type	Default	Required?
-t	dem.	bool	false	No

deploy

CLI command for deploy Docker containers with your project via Ansible to the remote server.

ts deploy [OPTION]

Option	Description	Type	Default	Required?
-k	Prompt you to provide the remote user sudo password (a standard Ansible --ask-become-pass option).	bool	false	No

Built With

• yargs
• tslog
• subslate
• merge-deep
• ajv
• to-json-schema

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/github_username/repo_name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [ ] Feature 1
• [ ] Feature 2
• [ ] Feature 3
  • [ ] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)