https://github.com/digipolitan/runtime-environment
https://github.com/digipolitan/runtime-environment
env environment environment-variables json plist runtime swift
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/digipolitan/runtime-environment
- Owner: Digipolitan
- License: bsd-3-clause
- Created: 2017-09-29T12:13:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-30T12:08:34.000Z (almost 6 years ago)
- Last Synced: 2025-02-28T16:57:29.453Z (3 months ago)
- Topics: env, environment, environment-variables, json, plist, runtime, swift
- Language: Swift
- Size: 103 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
RuntimeEnvironment
=================================
[](https://developer.apple.com/swift/)
[](https://travis-ci.org/Digipolitan/runtime-environment)
[](https://img.shields.io/cocoapods/v/RuntimeEnvironment.svg)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](http://cocoadocs.org/docsets/RuntimeEnvironment)
[](http://twitter.com/Digipolitan)
RuntimeEnvironment manage all your environment variable with a specific environment set in your Info.plist file
## Installation
### CocoaPods
To install RuntimeEnvironment with CocoaPods, add the following lines to your `Podfile`.
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
pod 'RuntimeEnvironment'
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate RuntimeEnvironment into your Xcode project using Carthage, specify it in your `Cartfile`:
```
github 'Digipolitan/runtime-environment' ~> 1.0
```
Run `carthage update` to build the framework and drag the built `RuntimeEnvironment.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have your Swift package set up, adding RuntimeEnvironment as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/Digipolitan/runtime-environment.git", from: "1.0.0")
]
```
## The Basics
First you must set the environment mode in your Info.plist file
```xml
Environment
production
```
Authorized environment value are **development**, **staging**, **production**
After that, at runtime you must register all your variable as follow:
```swift
let env = RuntimeEnvironment.shared
env.set("API_KEY", "dsdqsiIDNSIQUdiusqdDSQ")
```
## Advanced
### Variable from dictionary
You can set multiple variable at once using dictionary
```swift
let env = RuntimeEnvironment.shared
env.set([
"secure": true,
"baseUrl": "http://localhost"
])
```
### Variable from file
2 file format are available: **json** & **plist**
```swift
let env = RuntimeEnvironment.shared
env.setFile("env.prod", format: .json)
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[email protected]).
## License
RuntimeEnvironment is licensed under the [BSD 3-Clause license](LICENSE).