chingu-voyages / v24-bears-team-04-be Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 3.06 MB

Voting Web App | Voyage-24 | https://chingu.io/

Python 90.08% HTML 9.92%

hacktoberfest voting-application election-administration

v24-bears-team-04-be's Introduction

My Choice API

Heroku App: https://mychoicebe.herokuapp.com/

API Documentation: https://mychoicebe.herokuapp.com/swagger-ui/

VOTE AND RESULTS

Endpoint: /vote/<election-id>

GET

FORMAT

{
  "id": <ELECTION ID>,
  "position_set": [
    {
      "id": <POSITION-ID>,
      "candidate_set": [
        ...
        {
          "id": <CANDIDATE ID>,
          "first_name": "",
          "last_name": "",
          "picture_self": null,
          "party": "",
          "gender": "",
          "ethnicity": "",
          "votes": 0,
          "positions": [
            ...
            <POSITION ID>,
            ...        
          ]
        }
        ...
      ],
      "name": "<POSITION NAME>",
      "locality": "<LOCALITY NAME>",
      "seats": 1,
      "election": <ELECTION ID>
    }
  ],
  "title": "<ELECTION TITLE>",
  "start_time": "2020-11-01T00:00:00Z",
  "end_time": "2020-11-04T00:00:00Z"
}

EXAMPLE

{
  "id": 3,
  "position_set": [
    {
      "id": 1,
      "candidate_set": [
        {
          "id": 2,
          "first_name": "Donald",
          "last_name": "Trump",
          "picture_self": null,
          "party": "Other",
          "gender": "Male",
          "ethnicity": "",
          "votes": 2,
          "positions": [
            1,
            4
          ]
        },
        {
          "id": 1,
          "first_name": "Joe",
          "last_name": "Biden",
          "picture_self": null,
          "party": "Other",
          "gender": "Male",
          "ethnicity": "",
          "votes": 5,
          "positions": [
            1,
            5
          ]
        }
      ],
      "name": "President",
      "locality": "USA",
      "seats": 1,
      "election": 3
    },
    {
      "id": 2,
      "candidate_set": [
        {
          "id": 3,
          "first_name": "Kamala",
          "last_name": "Harris",
          "picture_self": null,
          "party": "Other",
          "gender": "Female",
          "ethnicity": "",
          "votes": 4,
          "positions": [
            2
          ]
        },
        {
          "id": 4,
          "first_name": "Mike",
          "last_name": "Pence",
          "picture_self": null,
          "party": "Other",
          "gender": "Male",
          "ethnicity": "",
          "votes": 1,
          "positions": [
            2
          ]
        }
      ],
      "name": "Vice President",
      "locality": "USA",
      "seats": 1,
      "election": 3
    },
    {
      "id": 3,
      "candidate_set": [],
      "name": "Region 1 Senator",
      "locality": "R1",
      "seats": 2,
      "election": 3
    }
  ],
  "title": "2020 General Election",
  "start_time": "2020-11-01T00:00:00Z",
  "end_time": "2020-11-04T00:00:00Z"
}

POST

FORMAT

{
  ...
  "<POSITION ID>": "<CANDIDATE ID>",
  ...
}

EXAMPLE

{
  ...
  "1": "2",
  ...
}

v24-bears-team-04-be's People

Contributors

Watchers

v24-bears-team-04-be's Issues

Wireframe - Election Mangement

Add General Elections

Logout EP returns HTML

Expecting results as a JSON but getting HTML pages

Expected Results

EP to send feedback in JSON format

Actual Results

EP sending back a HTML page

Steps to Recreate

Send a GET request to https://mychoicebe.herokuapp.com/logout
Confirm results are in HTML

BE - Migrate BE code to it's own repo

What

Remove the python skeleton code from this repo, so that we shall only have the front-end app remaining here.

Why

We have just received the repo from our facilitators and we had already merged the skeleton starting point of the back-end.

New GitHub Repo

BE Repo: https://github.com/chingu-voyages/v24-bears-team-04-be

BE - Vote Resuts EP - GET Django

User can be an Election Officer (EO)

An Election Officer is not a voter
An EO is able to manage elections
An EO is able to manage positions
An EO is able to manage political parties
An EO is able to manage candidates
An EO email cannot be the same as a voters

Potential EO details

Name
Email
Staff ID

User is able to manage an election

Ability to curate an election in the system.
Set it's name
Set it's date
Set it's voting period
Run a mock election with sample of voters

Wireframe - Position Management

Add Positions to an election

User is unable to cast a vote using the POST /api/vote EP

Description
When I send a candidate's name to the EP, I am getting a Test Name with 0 votes every time with a successful 200 OK status.

Expected Result
The EP should return my candidate's name & increase his/her vote by 1 every time I vote.

Actual Result
Get same result, _id: 1, Name: Test Name, Votes: 0

Steps To Recreate

Use mychoice-api.herokuapp.com as the base_url
Enter EP: /api/vote with the POST method
Add a candidate_name key:value pair in the body as JSON

{ 
    "candidate_name": "John McCain"
}

Send the request
View results

Screenshot

User is able to manage a political party

Ability to add/edit/disable a political party in the system.
Set it's name
Upload it's logo

FE - Locality - Country Mgt pages

DATA - Locality

Map the constituencies in Kenya

Country [Name, Country Code, ISO-Long, ISO-Short]
County [ Name, Code ]
Constituency [ Name ,Code ]

Voyage 24 - Project Selection

Team review ideas & vote for the most suitable project to work on for the voyage.

Sprint 2 - Backlog Creation

Team to agree on the specific tasks that will be worked on in the upcoming sprint

Wireframe - Voting results

Allow a user to view the results of the voting session
Agreed to display results as a table

Login EP returns HTML

When you send a request to the login, it returns a HTML page as opposed to user details of the person who's logged in.

Expected Results

The user who has logged in

Actual Results

Dashboard HTML page

Steps to Recreate

Access the login url - https://mychoicebe.herokuapp.com/login
Send body data as json

{
  "username": "johndoe",
  "password": "abcd"
}

Confirm the results you get back

Screenshots

FE - Login forrm

Email field
Password field

Wireframe - Login Mangement

FE - Voting form

Wireframe - Election Officer Mangement

Add election officers

User is able to view voting results

DATA - Registered Political Parties

Name
Short_form

Ballot EP returns HTML page

Expecting results as JSON, getting results as HTML.

Expected Results

The EP to send back feedback as JSON.

Actual Results

Receiving feedback as a HTML page.

Steps to Recreate

Send a request to https://mychoicebe.herokuapp.com/vote/3
Confirm you get HTML page in response

Wireframe - Ballot form

Allow a user to view the candidates in the ballot
Allow a user to select their preferred candidate

User is able to manage positions

A position belongs to an election
A position may have many candidates running in it.
Candidates can only appear once in an election
A position may be restricted by age
A position may be restricted to a region

FE - Refactor Vote Submission code

Code is manipulating the DOM directly as opposed to doing it the React way.

BE - Configure Flask skeleton

DB: SQLite

FE - Deploy to Netlify

Sprint 1 Retrospective

Review what went well, What didn't?, What can we do to make the next sprint better

Wireframe - Manage Global Setup (Locality)

Region

Country
State
County
Constituency

BE - Deploy to Heroku

Team Meet & Greet

Team Introduction meetup

User is able to manage candidates

Candidates are people who will run for an election.
A candidate may belong to a political party.
A candidate can only run for 1 position in an election
Certain positions have age restrictions

Candidate potential details

Name
Gender
Date of Birth
Ethnicity
Passport Photo
Political Party Affiliation

Add frontend for election management

Wireframe - Candidate management

manage candidates

User is able to login

A user should be able to login to the application

It should display his role
It should display his constituency as a voter
It should have 2FA for real user confirmation
It should automatically timeout after 10 mins of inactivity

Potential Login Details

Email
Password
OTP Token
Google reCaptcha v3

Users can register as voters

A voter can participate in an election
A voter can self-register
A voter can only have one physical identity
A voter can not be older than 120 years old from his date of birth
A voter can only vote in positions that belongs to his region
A voter can vote for himself as a candidate
A voter has to be approved before logging in

Potential Voter details

name
gender
date_of_birth
ethnicity
email
mobile
constituency | county | state | county
passport_photo
identification_number
identification_type
identification_card_photo

BE - API - Get Voting results

Should include tests

chingu-voyages / v24-bears-team-04-be Goto Github PK

v24-bears-team-04-be's Introduction

My Choice API

VOTE AND RESULTS

GET

POST

v24-bears-team-04-be's People

Contributors

Watchers

v24-bears-team-04-be's Issues

Expected Results

Actual Results

Steps to Recreate

What

Why

New GitHub Repo

Expected Results

Actual Results

Steps to Recreate

Screenshots

Expected Results

Actual Results

Steps to Recreate

Recommend Projects

Recommend Topics

Recommend Org