https://github.com/royalgarter/prestart-config

https://github.com/royalgarter/prestart-config

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/royalgarter/prestart-config
• Owner: royalgarter
• Created: 2024-05-03T09:24:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-24T10:55:30.000Z (almost 2 years ago)
• Last Synced: 2025-03-16T18:33:06.789Z (over 1 year ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Prestart Config

## Introduction

Prestart Config is a command-line utility used to load and configure settings from various sources such as MongoDB, Google Sheets, and more.

## Environment Configuration

> [!IMPORTANT]

> Key information users need to know to achieve their goal.

> Before using prestart-config, you need to configure some environment variables as follows:

> In the directory there must be an [`.env`] file and the following variables must be configured 

- `MONGO_URL`: Connection URL to MongoDB (if using MongoDB).

- `GOOGLE_SERVICE_ACCOUNT_EMAIL`: Email of Google service account (if using Google Sheets).

- `GOOGLE_PRIVATE_KEY`: Private key of Google service account (if using Google Sheets).

> [!TIP]

> For a smoother process.

You can obtain the `GOOGLE_SERVICE_ACCOUNT_EMAIL` and `GOOGLE_PRIVATE_KEY` by following the instructions provided by Google [here](https://cloud.google.com/iam/docs/keys-list-get).

Note: For the `GOOGLE_PRIVATE_KEY` environment variable, you need to provide the private key as a string, but keep in mind that this string is often long and distributed. Make sure you copy this string accurately.

## Example Usage: 

> [!NOTE]

> Helpful advice for doing things better or more easily.

   

   * `-f, --from `     Specifies the configuration source. Acceptable values are: ***mongo***, ***Mongo Url***, ***Google Sheet Url***.

   * `-s, --source `  Specifies the configuration source details. For MongoDB, this is the ***collection name***; for Google Sheets, this is the ***sheet name***

   * `-d, --dir `        Specifies the output directory.

   * `-q, --query `    Specifies a configuration query.

   * `-i, --init`             Initializes the configuration.

   * `-h, --help`            Displays help for the command.

  ### npx

  ```sh

  npx -y prestart-config -f  -s  -d 

  ```

  1. **Load configuration from MongoDB:** 


     * If use config mongo .env


        * Example: `npx -y prestart-config -f mongo -s  -d `


     * If use Mongo URL Connection 


        * Example: `npx -y prestart-config -f  -s  -d `

  2. **Load configuration from GoogleSheet:**


        * Example: `npx -y prestart-config -f  -s  -d `

## Reference Documentation

Detailed reference documentation for prestart-config can be found at [GitHub Pages](https://github.com/royalgarter/prestart-config).