Skip to content

SimpleState lets you REACT to the news with a clickable map interface, displaying state-level covid stats, voting facts, and senator contacts. Also includes a news search and a trending news database.

License

Notifications You must be signed in to change notification settings

JPBrickhouse/projectthree

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple State

License: MIT

Deployed Website:

DESCRIPTION

"No Alternatives, Just Facts"
As someone who is not always interested in reading from dozens of different sources on the daily, and getting overwhelmed with unneccessary content, "Simple State" is the place to quickly acquire data-driven information.
"Simple State" is a single-page application and an all-encompassing platform, with immedidate access to up-to-date Covid Statistics, state facts, contact information for US senators, and filtered news searches.

SCREENSHOTS

Login and Signup Pages

Login and Signup pages

Full Home Page

Home Page

Map Selection and Button Options

Map Selection and Buttons

Contact Your Senators

Contact Your Senators

News Search and Display Cards

News Search and Display

Trending News

Trending News

TABLE OF CONTENTS

INSTALLATION

  • No installation is required, as the user can simply visit the deployed application link: https://project-three-2020.herokuapp.com/
  • However, if the user wishes to investigate the code locally, the following steps should be performed:
    • Clone the repo for use on your local machine
    • Use the command line to locate the cloned repo and make it your current directory
    • Type npm install in the command line; this will install the necessary node module packages and dependencies

USAGE

  • To run the application locally...
    • Use the command line to locate the cloned repo and make it your current directory
    • Ensure that a local database connection to MongoDB is open and running
    • Simply type npm start in the command line
    • This will open a localhost connection on your default browser, wherein the React application will run
  • To run the application online, please visit the deployed link: https://project-three-2020.herokuapp.com/
  • Application functionality is identical whether you are running the server locally or visiting the deployed link:
    • Upon arriving at the page, users can either sign-up or log-in
    • Once the user is logged-in, they arrive on the "Simple State" landing page, with features styled by Material UI
    • The user selects one of the continguous United States, utilzing a map feature designed with Leaflet and React Leaflet
    • Upon selection of a United State, associated relevant data becomes subsequently accessible
      • Covid-19 - up-to-date statistics, sourced from The Atlantic
      • Senators - contact your representatives via Twitter, sourced from ProPublica
      • State Facts - learn about population, electoral college votes, and more, sourced from the US Census Bureau
    • The user can also search for news articles (sourced from the New York Times), which are filtered by the selected United State
      • All news searches are saved to the database (POST)
      • News searches are also retrieved from the database (GET); they undergo several filters before being displayed as "trending news"
        • They are sorted by date (to retrieve only the most recent searches)
        • They are filtered by user, so that the user can see their most recent search history, alongside the entire community's most recent searches
    • At any point and time, the user can re-select a different United State, and the corresponding information will update to match that state

LICENSE

License: MIT License
https://opensource.org/licenses/MIT

CONTRIBUTING

About

SimpleState lets you REACT to the news with a clickable map interface, displaying state-level covid stats, voting facts, and senator contacts. Also includes a news search and a trending news database.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages