citizenlabsgr / mittens Goto Github PK

View Code? Open in Web Editor NEW

8.0 4.0 4.0 1.33 MB

A chat app to check voter registration.

Home Page: https://vote.citizenlabs.org

License: MIT License

TypeScript 55.02% HTML 0.65% CSS 0.41% Shell 0.63% JavaScript 4.02% Makefile 2.50% Python 36.72% Procfile 0.04%

mittens's Introduction

Michigan Voter Engagement

Slack channel: #project-mittens

Project Description:

A social tool for encouraging eligible citizens in the Grand Rapids area to vote in local elections.

Project Guide:

The project is split into a backend API and a web frontend.

Maintainers (people with write access):

Jace Browning
Sam Bleckley

Skills

Skills you may learn or already posses relevant to this project:

Django
API design
React
Typescript
MobX
HTML
CSS

Getting Started

We welcome contributions from first timers
Join the slack channel and tell us about what you can do, and what you'd like to learn to do, and we'll find a first task that's right for you.
Core maintainers and project guides are responsible for reviewing and merging all pull requests. In order to prevent frustrations with your first PR we recommend you reach out to our core maintainers who can help you through your first PR.
Need to practice working with github in a group setting? Checkout github-playground
Updates to documentation or README are greatly appreciated and make for a great first PR. They do not need to be discussed in advance and will be merged as soon as possible.

Setup

Requirements

To run the application locally, you will need the following:

make
Python, pipenv
Node, Yarn
PostgreSQL

Follow the guides for macOS and Windows 10.

To confirm these system dependencies are configured correctly:

$ make doctor

Installation

To install backend/frontent project dependencies:

$ make install

Development

Create a development database and seed it with data:

$ createdb voterengagement_dev
$ make data

# OR

$ make reset

To run the backend/frontend development server:

$ make run

Unless MANDRILL_API_KEY is set, sent emails will appear in your terminal.

mittens's People

Contributors

Stargazers

Watchers

Forkers

tammycole crevax donaldwasserman philanthrolab

mittens's Issues

How should we handle erroneous region names from the SOS?

For example, many districts have the word "district" twice in their name:

Should we clean this up in our own data and consider "16th District" and "16th District District" to be the same region? Should we defer cleanup until presentation of the data? Something else?

Include a link to this repository in the footer

Given that one of the goals of Citizen Labs is openness, we should include a link back to this repository somewhere on the site, such as the footer.

Discussion: Who can see my registration?

I propose we implement a one-way friendship system similar to Twitter DM permissions. We'll want a better term for this, but I'm going to use "follow" for simplicity.

If I follow you then you can see my voter progression (from registration through voting). You can also choose to "hide" me in the event that I am not really your friend.

If you follow me back then I can see your voter progression.

If I know your (A) voter information (legal name, birthday, zip code) or (B) registered email address, then we are implicitly following each other. You can always hide or block me.

If I don't know your voter information, but do know your email address, I can invite you. We will be following each other when you complete signup.

There may be additional levels of "friendship" later on that let voters share opinions.

Move or hide the footer on mobile

"View on GitHub" can overlap buttons and fields:

Email confirmation link redirects to a 404

Sign up for email alerts
Click the "Confirm Registration" link
After going to vote.citizenlabs.org/login, you get redirected to vote.citizenlabs.org/registration-verified which says "Sorry, that page does not exist."

Skip identity prompt when logged in

Mittens can jump right to checking registration status.

This should also fix #65.

The bottom of the chat isn't visible on mobile

One Mittens starts talking, one has to scroll to the bottom of the page to see the full conversation.

Reloading '/registration-verified' prompts for email

Steps

Go to https://vote.citizenlabs.org/login
Submit form with an existing voter's email
Click link in email to log in
Confirm you are taken to https://vote.citizenlabs.org/registration-verified
Reload the page

Expected

Reloading the page has no effect on the page's content.

Actual

An email form appears.

Unsubscribe from future communication

What does this feature look like?

Month selection is not visible in Firefox

Can anyone else reproduce this?

Open MI SOS and GitHub links in new tabs

Check if zip code is in Michigan

I just gave this a spin, and I live in Georgia. When I enter my zip code it just says "Hmm! I wasn't able to find you. Is this information correct? Did you use your legal name?" - maybe instead it should do a validation check, and if the zip code is in another state, link to that state's Secretary of State or voter registration page?

Trim spaces from inputs

The error message on iOS Safari does not indicate the requirements of the zip code field.

"Registration" link in chat response is broken

The link should be https://www.michigan.gov/sos/elections/voting/register-to-vote

Clean up SendGrid keys

If we merge and deploy #40 we need to remove SendGrid keys from Heroku.

Indicate loading when the registration form submits

It will always take bit of time to check if a voter is registered so we should show this visually.

This is especially noticeable when pressing enter to submit the form.

Fix hot reloading on the dev server

Replace Pipenv with Poetry

Indicate that your legal name is requried

I entered "Josh" instead of "Joshua" and was told "Hmm! I wasn't able to find you." I should have known to use my legal name and the bot did ask me to clarify, but perhaps a prompt in the hint text would help avoid this easy mistake altogether?

Ensure zip codes are 5 digits

Disable negative numbers on form birthday input.

Mark email addresses as confirmed

The same table could also store unsubscribed emails for #63.

Prompt users to check the spelling of their name

Rather than immediately tell someone they're not registered to vote, we should ask them to confirm the correct spelling of their name before sending them to the "unregistered" page in the event that the SOS comes back negative.

Show a message when the MI SOS is down

With citizenlabsgr/elections-api#71, the API now returns a 503 when it appears the MI SOS is having a partial outage. We should forward this information to the chat:

Update response text when checking if registered to vote

This work was started here, but we left in some placeholder messages: #8

Images are missing during local development

Displayed birthday is one day later than entered

A user entered a birthday of April 22, but it was displayed as April 21 on the frontend after submission.

The backend logs show the correct date: GET /api/registration/?first_name=<...>&last_name=<...>&birth_date=1980-04-22&zip_code=<..>.

This was after 10pm EDT (when considering timezone bugs).

Accept numerical or text for Birth Month

Current behavior: It seems the birth month must be the name of the month spelled out. The name must even be in proper case.

Desired behavior: The birth month should accept both the month name (any case) or its ordinal number.

Example: "7", "July", and "july" should all be accepted as "July".