planning.txt

Voting Application
- a web application where user can vote to the given
  set of candidates

User Roles:
1. user sign in / sign up using aadhar card number
2. change their password
3. see the list of candidates
4. vote only to one of the candidates
5. there should be a route which shows the list of
   candidates and their live vote counts sorted by
   their vote counts
6. user data must contain one unique government
   id proof named: aadhar card number

Admin Roles:
1. add / update candidates
2. admin can't vote

------------------------------------------------------

Routes:

User Authentication:
    /signUp: POST - Create a new user account
    /login: POST - Log in to an existing account
                   { aadhar card number + password }

Voting:
    /candidate: GET - Get the list of candidates
    /vote/:candidateId: POST - Vote for a specific candidate

Vote Counts:
    /vote/count: GET - Get the list of candidates sorted
                        by their vote counts

User Profile:
    /profile: GET - Get the user's profile information
    /profile/password: PUT - Change the user's password

Admin Candidate Management:
    /candidate: POST - Create a new candidate
    /candidate/:candidateId: PUT - Update an existing candidate
    /candidate/:candidateId: DELETE - Delete a candidate from the list