Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 2.88 KB

README.md

File metadata and controls

83 lines (54 loc) · 2.88 KB

Grandstart

CodeQL

This project provides a simple CLI tool to generate Grandstream HT-812, HT-814, and HT-818 configuration files from a CSV dataset.

TL;DR - Linux

To get started quickly with a simple deployment, execute the following bash commands on a *nix based system with git, python3, python3-pip, and python3-venv installed:

git clone https://github.com/AzorianSolutions/grandstart.git
cd grandstart
./deploy/bare-metal/linux/debian.sh
source venv/bin/activate
grandstart run -i /path/to/input.csv -o /path/to/output/directory

TL;DR - Windows

Start with checking out the project's official repository using git. The official repository can be cloned from https://github.com/AzorianSolutions/grandstart.git.

cd C:/Path/To/Project/Root
python3 -m venv venv
venv\Scripts\activate
pip install -e .
copy deploy\config\defaults.env deploy\config\production.env

Edit the default settings as needed in deploy\config\production.env.

Then, run the following commands each time you want to activate the project for use:

cd C:/Path/To/Project/Root
venv\Scripts\activate
for /F %A in (deploy\config\production.env) do SET %A
grandstart run -i C:/Path/To/Input.csv -o C:/Path/To/Output/Directory

Project Documentation

Configuration

Grandstart is configured via environment variables. Until I can provide more in-depth documentation of the project, please refer to the default values in deploy/config/defaults.env for a list of the environment variables that can be set.

To see the concrete implementation of the settings associated with the environment variables, please see the src/app/config.py file.

Contributing

This project is not currently accepting outside contributions. If you're interested in participating in the project, please contact the project owner.

Please see our Security Policy.

Please see our Support Policy.

Please see our Code of Conduct.

This project is released under the MIT license. For additional information, see the full license.

Like my work?

Buy Me A Coffee

Want to sponsor me? Please visit my organization's sponsorship page.