Skip to content

Commit

Permalink
readme and gh actions
Browse files Browse the repository at this point in the history
  • Loading branch information
pradovic committed Feb 7, 2024
1 parent 006a90d commit fe4510c
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Rust

on: [push, pull_request]

jobs:
build_and_test:
name: Build and Test
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
rust: [stable]
fail-fast: true
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.rust }}
profile: minimal
override: true

- name: Cache Cargo dependencies
uses: actions/cache@v3
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-
- name: Run Clippy
if: matrix.rust == 'stable' && matrix.os == 'ubuntu-latest'
uses: actions-rs/clippy-check@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}

- name: Install cargo-audit
run: cargo install cargo-audit

- name: Audit dependencies
run: cargo audit

- name: Build
run: cargo build --verbose

- name: Run tests
run: cargo test --verbose
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Direct Decisions Discord Bot

This is a functional prototype level discord bot preferential voting that uses [Direct Decisions](https://directdecisions.com) v1 API.

You can view Direct Decisions API v1 docs here: [https://api.directdecisions.com/v1](https://api.directdecisions.com/v1)

It enables direct democracy style polls/elections. Results are calculated using [Schulze method](https://en.wikipedia.org/wiki/Schulze_method).

## Features
- Create votings
- Delete votings
- Vote with a ballot
- Complete voting and publish/follow results

## TODO

- Voting management
- Continious votings
- Improving UX

## Status

This is a MVP/prototype level application, which supports minimum set of features to enable preferential votings. Development is still in progress.

## License

This library is distributed under the BSD-style license found in the [LICENSE](LICENSE) file.

0 comments on commit fe4510c

Please sign in to comment.