geoffjay / 7g-tooling Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 2.35 MB

Makefile 0.66% Go 44.56% Dockerfile 0.47% TypeScript 3.05% CSS 28.24% JavaScript 23.01%

7g-tooling's Introduction

Tooling Project

[WIP] pre-alpha, doesn't do anything, might burn your house down.

Install

Homebrew

For macOS only, this is the quickest way to get going. This may not be the most up-to-date version.

brew install geoffjay/tap/sg-tooling

Build

Building from source will be the most up-to-date, but is more likely to have errors.

git clone <this repo>
cd 7g-tooling
make

The resulting binary will be at target/7g, at this time there is no make target to install.

CLI

`deploy`

`initialize`

7g deploy initialize

`branch`

7g deploy branch feat/nonsense

`destroy`

7g deploy destroy

`network`

[TODO]

`populate`

`automate`

`daemon`

[TODO]

`enable`

`disable`

`start`

`stop`

`status`

`gql`

`get-objective`

[TODO]

Service

Building and running the web service during development is done using:

make setup
make
SG_CONFIG=configs/config.yml ./target/7g daemon

API

Swagger

Install the swag utility.

go get -u github.com/swaggo/swag/cmd/swag

To build Swagger documentation for the REST API.

make docs
make

Now when running the documentation should be available at http://localhost:3000/swagger/index.html.

Ping

http://localhost:3000/v1/ping

Deployment

Initialize

http://localhost:3000/v1/deploy/initialize

Branch

http://localhost:3000/v1/deploy/branch/<branch_name>

Network

Populate

http://localhost:3000/v1/network/populate

POST

returns?

POST

takes yaml file

Automate

http://localhost:3000/v1/network/automate

GET

returns?

POST

takes xlsx file?

Configuration

API key
server settings?

http://localhost:3000/v1/config/:key/

GET

POST

Contributing

To contribute to development ...

python3 -m venv .venv
pip install pre-commit
pre-commit install

Running

During development the server can be run using air for hot-reloading with make server.

7g-tooling's People

Contributors

Watchers

7g-tooling's Issues

Use SG_ENV to load different .env files

Currently, the file .env is the only one that is loaded. The package for godotenv has an example on how to load eg. testing/development that would be good to use.

Create documentation in GH Wiki

Use Github Wiki for documentation

install
quick start
configuration
- schema(?)
CLI
UI

GQL > Create addUser in SG

Use launchd to manage service

https://pkg.go.dev/github.com/keybase/client/go/launchd?tab=doc

Build branch deployment page

According to Miro wireframe.

Add hot reload for Go service

Options:

Build and release electron app

Use Github actions to build and release a distribution of the election app.

Make repository private

Need to figure out / test:

Github actions
goreleaser push to tap repo
Github token for installing with brew

Build deploy/automate page

According to Miro wireframe.

Improve import workflow

It's a pain to generate the populate and automate input files, it would be better to have the ability to construct the file using a user interface.

Workflow

if open in UI
- load populate/automate file as yaml
if create new in UI
- start with blank
display everything in tabs(?) or some other interface type
allow edits
allow new/delete objects (objectives, badges, etc.)
save

Document network setup steps

To have a bare network for provisioning, do the following:

create network (not demo)
accept admin account
create static API token for network admin

Build configuration page

According to Miro wireframe.

Move from CircleCI to Github Actions

Having both seems pointless, may as well just do everything in Github.

Perform initialization and execution

A new user should be able to use the software in some minimal number of steps, eg.

Command-line

brew install geoffjay/tap/sg-tooling
7g init
7g daemon enable
7g daemon start

User Interface

open configuration page
initialize project if not already initialized
- clicking init button calls 7g init
enable daemon on startup -> 7g daemon enable
start daemon -> 7g daemon start

Initialization

sets up project directories
sets up default configuration

Daemon

Enable

copies plist template

Start

runs launchctl load com.7geese.tooling

Replace collection map strings with const/iota

Shouldn't use string keys, better to define indexes as a const and use those.

Fix objective import

Importing from yaml creates objective with KR information, but page bails when you visit it.

REST to GQL > change 'updateOneononeTemplate' to 'createAndUpdateOneononeTemplate'

Finished changing the updateOneononeTemplate mutation to support creation as well

This ticket pertains to the rest-to-gql branch on main app

geoffjay / 7g-tooling Goto Github PK

7g-tooling's Introduction

Tooling Project

Install

Homebrew

Build

CLI

deploy

initialize

branch

destroy

network

populate

automate

daemon

enable

disable

start

stop

status

gql

get-objective

Service

API

Swagger

Ping

Deployment

Initialize

Branch

Network

Populate

Automate

Configuration

Contributing

Running

7g-tooling's People

Contributors

Watchers

7g-tooling's Issues

Workflow

Command-line

User Interface

Initialization

Daemon

Enable

Start

Recommend Projects

Recommend Topics

Recommend Org

`deploy`

`initialize`

`branch`

`destroy`

`network`

`populate`

`automate`

`daemon`

`enable`

`disable`

`start`

`stop`

`status`

`gql`

`get-objective`