Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Begin Feature List #180

Closed
1 of 4 tasks
keithrfung opened this issue Nov 4, 2021 · 0 comments · Fixed by #192
Closed
1 of 4 tasks

📝 Begin Feature List #180

keithrfung opened this issue Nov 4, 2021 · 0 comments · Fixed by #192
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@keithrfung
Copy link
Collaborator

Is there an existing issue for this?

  • I have searched the existing issues

Suggestion

Understanding what electionguard includes and specifically what certain implementations include is important. The expectation is some sort of table including different information for the mandatory pieces included in certain types of implementations and a descriptive list of features and how they work, perhaps with some links to the specifications.

This should be added to this page
www.electionguard.vote/overview/Features/

Possible Implementation

Here is an outline that can be used. Update the markdown in Features.md

  • Add Badges
  • Add links to the repositories and packages
  • Do NOT remove under construction label
# Features

The ElectionGuard SDK is made of several components. There are two developer options for stacks: Python and C++. Here is a list of the available SDK's and the supported features per stack. 

## ElectionGuard SDK 1.0.0  [ADD BADGE HERE]

### Components
- `electionguard` 
    - 💻. [Source]()
    - 📄   Specification 1.0.0 _(Under Construction)_
    - 📄  JSON Schema 1.0.0 _(Under Construction)_
- `electionguard-python`
    - 💻. [Source]()
    - 📦  Python Package: electionguard ([pypi](version1.3.0), [github]())
- `electionguard-api-python`
    - 💻. [Source]()
    - 🐳  Docker Container: API _(Under Construction)_
- `electionguard-ui`
   - 💻. [Source]()
   - 🐳  Admin App Docker Container _(Under Construction)_
   - 🐳  Result App Docker Container _(Under Construction)_
   - 📦  NPM Package: API Client _(Under Construction)_
- `electionguard-cpp`
   - 💻. [Source]()
   - 📦  Nuget Package: ElectionGuard.Encryption _(Under Construction)_
   
### Features: 
| Feature                                |   Python Stack         |   C++ Stack              |
| ---------------------------| ------------------  |  ------------------  |
| Ballot Encryption                 | :material-check:     |   :material-check:    |
| Compact Ballot                   | :material-check:    |    :material-check:    |
| Encryption Key Ceremony   |:material-check:    |                                 |
| Tally Decryption Ceremony      |   :material-check:  |                                 |

## ElectionGuard SDK 0.95.0 [ADD BADGE HERE]

- `electionguard` 
    - 💻. [Source]()
    - 📄   Specification 0.95.0 ([pdf](), [web]())
    - 📄  JSON Schema 0.95.0 _(Under Construction)_
- `electionguard-python`
    - 💻. [Source]()
    - 📦  Python Package: electionguard ([pypi](version1.0.0), [github]())
- `electionguard-api-python`
    - 💻. [Source]()
- `electionguard-cpp`
   - 💻. [Source]()

### Features: 

| Feature                                |   Python Stack         |   C++ Stack              |
| ---------------------------| ------------------  |  ------------------  |
| Ballot Encryption                 | :material-check:     |   :material-check:    |
| Encryption Key Ceremony   |:material-check:    |                                 |
| Tally Decryption Ceremony  |   :material-check:  |                                 |

Anything else?

No response

@keithrfung keithrfung added help wanted Extra attention is needed good first issue Good for newcomers documentation Improvements or additions to documentation labels Nov 4, 2021
@keithrfung keithrfung self-assigned this Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant