@codrjs/config v1.0.7

@codrjs/config

Purpose

This repository is a custom-built configuration manager for all repositories. This module manages everything configuration and should be used in all projects manages so that environment variables are unified, making transitioning development from one domain to another easy.

Getting started

Install the package from the npm registry.

yarn add @codrjs/config

Import the config package and use the variables you need!

*Please note: This package assumes you have defined the environment variables you are accessing and does no error checking.*

/* Import the config package */
import config, { ExpressConfig } from "@codrjs/config";
import { express } from "express";

const app = express();

app.listen(config.express.port, config.express.host, () => {
  console.log(
    `Server is starting on ${ExpressConfig.host}:${ExpressConfig.port}`,
  );
});

Environemnt Variable Names

Location of environment variable is postfixed to Config.{location} (e.g. Config.express.host).

TODO

• ...

Contributing

# Clone the repo
git clone git@github.com:CodrJS/config.git

# Install yarn if you don't have it already
npm install -g yarn

# Install dependencies, build, and test the code
yarn install
yarn build
yarn test