Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.89 KB

README.md

File metadata and controls

66 lines (45 loc) · 1.89 KB
Raw

AICE GitHub Dashboard Server

Coverage Status

Usage

Before running the app, create a toml extension file and write it in the format below.

[web]
address = "127.0.0.1:8000"
key = "key_path"
cert = "cert_path"

[[repositories]]
owner = "aicers"
name = "github-dashboard-server"

[[repositories]]
owner = "aicers"
name = "github-dashboard-client"

[certification]
token = "github_token_info"
ssh = ".ssh/id_ed25519"

[database]
db_name = "db_name"
  • address: Address of web server.
  • key: tls key path of web server.
  • cert: tls cert path of web server.
  • owner: The owner of the github repository.
  • names: The name of the github repository.
  • token: Generated github access token value. (Token Generation: github-access-token)
  • ssh: Path to ssh private key for github code checkout.
  • db_name: The name of the db to create/connect.

Build and serve the app with Cargo as follows:

cargo run [-- FLAGS | OPTION]

When you run the program, server reads the config file from the default folder.

To run without giving the config file option, save the file to the path below.

  • Linux: $HOME/.config/github-dashboard-server/config.toml
  • macOS: $HOME/Library/Application Support/com.einsis.github-dashboard-server/config.toml

The web server will run using the address value in the config file.

Connect to https://localhost:8000 in your browser to run the app,

  • https://localhost:8000/graphql/playground to playground

FLAGS

  • -h, --help: Prints help information
  • -V, --version: Prints version information

OPTION

  • config_file: The path to the toml file containing server config info.