The gui-environment
package is a command-line tool that simplifies managing environment variables for your application. Easily set up different configurations based on your build mode (development, staging or production) for a smooth development workflow.
Install the package:
$ npm install -D gui-environment
Initialize your project's environment:
$ npx gui-environment --init
# Using a custom source path
$ npx gui-environment --src="custom-src" --init
Include the gui-environment
binary in your package.json
file:
...
"scripts": {
"build-dev": "gui-environment --development && tsc && ...",
"build-staging": "gui-environment --staging && tsc && ...",
"build-production": "gui-environment --production && tsc && ...",
// Using a custom source path
"build-dev": "gui-environment --src='custom-src' --development && tsc && ...",
}
...
project
│
src/
│ ├───components/
│ │ └───...
│ ├───environment/
│ | ├───environment.development.ts
│ | ├───environment.production.ts
│ | ├───environment.staging.ts
│ | ├───environment.ts
│ | └───types.ts
│ └───main.tsx
│
package.json
tscofig.json
...
Once initialized, include your environment variables in the following files accordingly:
-
environment.development.ts
-
environment.production.ts
-
environment.staging.ts
Use the environment variables anywhere:
// main.tsx
import { ENVIRONMENT } from './environment/environment.ts';
ENVIRONMENT
// {
// production: false,
// version: '1.0.0'
// }
Important: keep in mind that whatever data you include in these files will be public when your app is deployed. Avoid sharing sensitive information such as API keys, secrets, etc...
- TypeScript
# Unit Tests
$ npm run test:unit
# Integration Tests
$ npm run test:integration
Install dependencies:
$ npm install
Build the project:
$ npm start
Publish to npm
:
$ npm publish