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.

Sign up for GitHub

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

Jump to bottom

More docs #8

Merged
merged 2 commits into from
Jan 20, 2024
Merged

More docs #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6595f28
more documentation
kjs222 Jan 20, 2024
f2696d3
more documentation 2
kjs222 Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

It may be easiest to read this README (with images) on Github: https://github.com/kjs222/congressional-app

### Overview

This application queries the ProPublica API daily for new senate and house votes. It does analysis on the recent votes and provides a front end application to display that information.

## Tech Stack

- React Typescript frontend
Expand Down Expand Up @@ -43,6 +47,7 @@ I chose a no SQL database for a variety of reasons:
- Deployed on: AWS Lambda (serverless)
- Invoked by: Scheduled AWS Event Bridge Event
- Code path: backend/src/data-collector
- Entry point: handler function in `backend/src/data-collector/handler.ts`

Purpose:

Expand All @@ -59,6 +64,7 @@ To effectively decouple the data collector for the data analyzer (and allow them
- Deployed on: AWS Lambda (serverless)
- Invoked by: SQS Event
- Code path: backend/src/data-analyzer
- Entry point: handler function in `backend/src/data-analyzer/handler.ts`

Purpose:

Expand All @@ -70,6 +76,7 @@ Purpose:
- Deployed on: AWS Lambda (serverless) with AWS API Gateway (routing, etc)
- Invoked by: HTTP API
- Code path: backend/src/api
- Entry point: handler function in each file in the directory `backend/src/api/handlers`

Purpose:

Expand Down Expand Up @@ -189,3 +196,10 @@ npm run start-local-ddb
```

I am not exposing the env variables needed to actually run the application however (sorry)

#### Next features to add

I added an MVP frontend, but I would minimally like to add the following:

- A way to scroll to get more votes (right now it is just retrieving the last 20)
- A way to display vote analysis by the state of the member (this data exists on the backend, but hasn't been exposed on the frontend)
3 changes: 0 additions & 3 deletions frontend/src/VoteCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ export const VoteCard: React.FC<{ item: VoteOverview}> = ({ item }) => {
<Typography variant="body2">
{item.description}
</Typography>
<Typography variant="body2">
<Link href={item.url}>See on Congressional website</Link>
</Typography>

<Button onClick={handleSeeDetails} variant="contained" color="secondary">See Analysis</Button>
</CardContent>
Expand Down
Loading