Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fullstacksjs/config
Configuration manager
https://github.com/fullstacksjs/config
config environment environment-variables
Last synced: 3 months ago
JSON representation
Configuration manager
- Host: GitHub
- URL: https://github.com/fullstacksjs/config
- Owner: fullstacksjs
- License: mit
- Created: 2023-08-17T20:45:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-26T10:03:48.000Z (5 months ago)
- Last Synced: 2024-06-27T10:20:54.451Z (5 months ago)
- Topics: config, environment, environment-variables
- Language: TypeScript
- Size: 1.61 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
![download status][download-badge]
![version][version-badge]
![Code Coverage][coverage-badge]
![MIT License][license-badge]
![semantic-release][semantic-badge]
## Config
a type-safe, simple yet powerful library for defining and accessing configuration.
## Table of Contents
- [Installation](#installation)
- [NodeJS](#nodejs)
- [Deno](#deno)
- [Browser](#browser)
- [Contributing](#contributing)
- [Prerequisite](#prerequisite)
- [Pull Request](#pull-request)
- [Code of Conduct](#code-of-conduct)
- [Documentation](#documentation)
## Installation
### NodeJS
```sh
$ npm install --save-dev @fullstacksjs/config
```
### Deno
```typescript
import { Config } from 'https://raw.githubusercontent.com/fullstacksjs/config/main/mod.ts'
```
### Browser
```html
console.log(window.Config)
```
## Contributing
Development of config happens in GitHub, and we appreciate contributions.
### Prerequisite
- [volta][volta]
- [bash][bash]
### Pull Request
The FullstacksJS team is monitoring for pull requests. We will go ahead and review your pull request as soon as possible.
Before submitting a pull request, please make sure the following is done:
- Fork the repository and create your feature branch from the `next` branch.
- Run `npm install` to have all dependencies.
- To start development run `npm run test:watch`.
- Write tests and implementation.
- Ensure everything is ok `npm run verify`.
- Create an PR against the `next` branch.
## Code of Conduct
[FullstacksJS Rules Page](https://fullstacksjs.com/rules)
## Documentation
Please check out the [documentation page](https://config.fullstacksjs.com)
[download-badge]: https://img.shields.io/npm/dm/@fullstacksjs/config?color=EF6969&label=DOWNLOADS&style=flat-square
[version-badge]: https://img.shields.io/npm/v/@fullstacksjs/config?color=098FAA&label=VERSION&style=flat-square
[coverage-badge]: https://raw.githubusercontent.com/fullstacksjs/config/assets/assets/coverage.svg
[license-badge]: https://img.shields.io/npm/l/@fullstacksjs/config?color=EA5F12&label=LICENSE&style=flat-square
[semantic-badge]: https://img.shields.io/badge/semantic-release-e10079.svg?logo=semantic-release&color=7E98F7&label=SEMANTIC&style=flat-square (https://github.com/semantic-release/semantic-release)
[volta]: https://volta.sh/
[bash]: https://www.gnu.org/software/bash/