{"id":4553,"url":"https://github.com/maxkomarychev/react-native-ultimate-config","last_synced_at":"2025-04-12T19:49:20.040Z","repository":{"id":38190389,"uuid":"250834073","full_name":"maxkomarychev/react-native-ultimate-config","owner":"maxkomarychev","description":"Config that works","archived":false,"fork":false,"pushed_at":"2024-07-29T16:40:04.000Z","size":9108,"stargazers_count":266,"open_issues_count":21,"forks_count":31,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-12T19:49:04.341Z","etag":null,"topics":["12factor","12factorapp","android","config","dotenv","env","environment","gradle","ios","java","javascript","monorepo","objective-c","react-native","typescript","xcconfig"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxkomarychev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-28T15:48:29.000Z","updated_at":"2025-02-09T08:14:06.000Z","dependencies_parsed_at":"2024-01-08T01:03:32.593Z","dependency_job_id":"5b25668f-6744-4419-aec7-a3fd9a606880","html_url":"https://github.com/maxkomarychev/react-native-ultimate-config","commit_stats":{"total_commits":157,"total_committers":10,"mean_commits":15.7,"dds":0.06369426751592355,"last_synced_commit":"16ed6cb32ccc24507ed09880c9e7e460f6666215"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Freact-native-ultimate-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Freact-native-ultimate-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Freact-native-ultimate-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Freact-native-ultimate-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxkomarychev","download_url":"https://codeload.github.com/maxkomarychev/react-native-ultimate-config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625501,"owners_count":21135513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["12factor","12factorapp","android","config","dotenv","env","environment","gradle","ios","java","javascript","monorepo","objective-c","react-native","typescript","xcconfig"],"created_at":"2024-01-05T20:17:16.086Z","updated_at":"2025-04-12T19:49:20.008Z","avatar_url":"https://github.com/maxkomarychev.png","language":"JavaScript","funding_links":[],"categories":["Components","JavaScript"],"sub_categories":["System"],"readme":"# react-native-ultimate-config\n\n_Config that works_\n\n[![NPM](https://img.shields.io/npm/l/react-native-ultimate-config)](https://www.npmjs.com/package/react-native-ultimate-config)\n[![npm](https://img.shields.io/npm/v/react-native-ultimate-config?color=green\u0026label=version)](https://www.npmjs.com/package/react-native-ultimate-config)\n[![npm](https://img.shields.io/npm/dw/react-native-ultimate-config?color=green)](https://www.npmjs.com/package/react-native-ultimate-config)\n\n_Project generated with https://github.com/brodybits/create-react-native-module_\n\n## Suport of gradle\n\n| react-native-ultimate-config | gradle |\n| ---------------------------- | ------ |\n| ^3                           | \u003c=6    |\n| \u003e4                           | 7      |\n\n## TL;DR usage\n\n1. install\n   |npm | yarn |\n   |-|-|\n   |`npm install react-native-ultimate-config` | `yarn add react-native-ultimate-config`|\n2. [one-off setup for native projects](./docs/quickstart.md)\n3. initialize env\n   |npm | yarn |\n   |-|-|\n   |`npm run rnuc \u003cenv file\u003e`|`yarn rnuc \u003cenv file\u003e`|\n4. build! `react-native run-{ios,android}`\n\n## ☝❗Approach to versioning and breaking changes\n\nThis library is using [semver](https://semver.org/) and heavily relying on codegeneration. Many new features and/or bugfixes will require these files to be regenerated. Changes to codegenerated files will not be considered breaking\nunless they affect behavior of API or CLI.\n\nTherefore every time this library is updated all files MUST be regenerated using `rnuc` command.\n\n## Table of contents\n\n1. [Features 🎆](#features)\n1. [Mission 🥾](#mission)\n1. [Quickstart Guide 🏃](./docs/quickstart.md)\n1. [API 🧰](./docs/api.md)\n1. [Changelog 📓](./packages/react-native-ultimate-config/CHANGELOG.md)\n1. [Cookbook 🥦](./docs/cookbook.md)\n1. [Troubleshooting 🎱](./docs/troubleshooting.md)\n1. [Contributor notes](./docs/contributor-notes.md)\n1. [Alternatives](./docs/alternatives.md)\n\n## Features\n\n1. Simple one-off [setup](./docs/quickstart.md) for native projects\n1. No need to mess with xcode schemes or android flavors\n1. Access from [javascript](./docs/api.md#javascript)\n1. Access from native code: [java](./docs/api.md#java) and [objective-c](./docs/api.md#objective-c)\n1. Access in build tools: [xcode](./docs/api.md#ios), [gradle](./docs/api.md#buildgradle) and [AndroidManifest.xml](./docs/api.md#androidmanifestxml)\n1. [Web support](./docs/api.md#web) (works with React Native for Web)\n1. [Hooks](./docs/api.md#hooks)\n1. [Monorepo support](./docs/monorepo-tips.md) (yarn workspaces or lerna)\n1. Unit tested with jest\n1. E2E tested with detox\n1. Provides typescript [typings](./docs/api.md#typescript)\n1. Supports [dotenv and yaml](./docs/api.md#files)\n1. [Fully typed](./docs/api.md#note-about-types) values available when using yaml config\n1. Configure values [per platform](./docs/api.md#per-platform-values) in one file\n\n## Mission\n\nReact-Native brings together 3 platforms: ios, android, javascript each of\nwhich have different conventions and approaches how to manage environment\nsettings.\n\nA typical app is usually operating in some environment defined by server urls\nvarious api keys or feature flags. When dealing with react-native such things\noften need to exist in 3 places: ios, android and js code. Even managing things\nas simple as application name or bundle id needs to be done in 2 places:\n`Info.plist` and `AndroidManifest.xml`\n\n`react-native-ultimate-config` tries to reduce friction in managing these things\nby abstracting away from nuances of native projects.\n\nWith `react-native-ultimate-config` it is possible to [consume](./docs/api.md) variables in\nevery place of a typical react-native app:\n\n- javascript\n- native code\n  - java\n  - objective-c\n- native build configuration\n  - ios\n    - build settings\n    - infoplist\n  - android\n    - build config\n    - string resources\n    - project.ext\n\n```\n|-------------------------------------------------------|\n|                                                       |\n|                     javascript                        |\n|                                                       |\n|-------------------------------------------------------|\n|                          |                            |\n|       objective-c        |           java             |\n|                          |                            |\n|-------------------------------------------------------|\n|                          |                            |\n|      build settings      |     AndroidManifest.xml    |\n|         infoplist        |        build.gradle        |\n|                          |                            |\n|-------------------------------------------------------|\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxkomarychev%2Freact-native-ultimate-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxkomarychev%2Freact-native-ultimate-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxkomarychev%2Freact-native-ultimate-config/lists"}