Skip to content

Latest commit

 

History

History
122 lines (105 loc) · 6.1 KB

README.md

File metadata and controls

122 lines (105 loc) · 6.1 KB
Raw

BLMLogo

BLM PLUS

Project for team 1's 2020 IBM Blue Movement Bootcamp

Description

This website seeks to complement the existing BLM website by providing an extended set of features not currently meet by the solution including:

  • Social Media posts and news articles related to Black Lives Matter movement
  • Information for Political Reperesentatives & State Bills Up for debate
  • Local and national Black Lives Matter movement chapters and their social media links
  • Local businesses owned by black owners

Technologies

  • React - Frontend: JavaScript library for creating web apps!
  • node.js - Evented I/O for the backend
  • Material UI - Frontend framework for UI design

API's

References

Installation / Usage

Two methods: Online and Local

Online Method (gh-pages branch)
Access via website: https://PrinceS25.github.io/BLM-Plus/

Local Method (master branch)
Requires node.js.

In order to run locally, you need to create an .env file in the root folder and define the following variables inside:

  • REACT_APP_TWITTER_BEARER_TOKEN
  • REACT_APP_NEWS_API_KEY
  • REACT_APP_REDDIT_CLIENT_ID
  • REACT_APP_REDDIT_CLIENT_SECRET
  • REACT_APP_REDDIT_REFRESH_TOKEN
  • REACT_APP_YELP_BEARER_TOKEN
  • REACT_APP_GOOGLE_GEOLOCATION_API_KEY
  • REACT_APP_GOOGLE_GEOCODE_API_KEY
  • REACT_APP_OPENSTATES_API_KEY

Environmental variable REACT_APP_TWITTER_BEARER_TOKEN can be obtained from Twitter API
Environmental variable REACT_APP_NEWS_API_KEY can be obtained from News API
Environmental variables REACT_APP_REDDIT_CLIENT_ID and REACT_APP_REDDIT_CLIENT_SECRET can be obtained from Reddit Developer Page
Environmental variable REACT_APP_REDDIT_REFRESH_TOKEN can be obtained from reddit-oauth-helper
Environmental variable REACT_APP_YELP_BEARER_TOKEN can be obtained from Yelp API
Environmental variable REACT_APP_GOOGLE_GEOLOCATION_API_KEY can be obtained from Google Geolocation API
Environmental variable REACT_APP_GOOGLE_GEOCODE_API_KEY can be obtained from Google Geocode API
Environmental variable REACT_APP_OPENSTATES_API_KEY can be obtained from Open States API\

See sample.env for an example.

$ git clone https://github.com/PrinceS25/BLM-Plus
$ cd BLM-Plus
$ ./run.sh

Team

  • Adedapo Adetayo
  • Daijon Bereola-Carson
  • Myles Cherebin
  • Anthonia Duru
  • Caitlynn Journey
  • Prabhjot Singh
  • Ekene Uzoegwu
  • Armani Weise
  • Perren Wright

Directory Structure

BLM-Plus
├── ...
├── flask_backend       # Python Backend server files
│   └── ...
├── public              # Files to display web page
│   └── ...
├── src
│   ├── components      # All frontend components used to display web pages 
|   |   ├── action              # Action component
|   |   |   ├── action.js               # Shows local and national representatives
|   |   |   ├── actionchild.js          # Generates cards for each representative
|   |   |   ├── searchbar.js            # Search bar component
|   |   |   └── table.js                # Table for all the cards
|   |   ├── feed                # Social Media Feed component
|   |   |   ├── cardGridInstagram.js    # Generates cards from Instagram
|   |   |   ├── cardGridNews.js         # Generates cards from News
|   |   |   ├── cardGridReddit.js       # Generates cards from Reddit
|   |   |   ├── cardGridTwitter.js      # Generates cards from Twitter
|   |   |   └── feed.js                 # Calls APIs and shows result
|   |   ├── protest             # Protest component
|   |   |   ├── cardGridProtest.js      # Generates cards for BLM chapters
|   |   |   └── protest.js              # Defines BLM chapters and displays them
|   |   ├── uplift              # Uplift component
|   |   |   ├── cardGridBlackBusiness.js    # Generates Business cards
|   |   |   └── uplift.js                   # Calls Yelp API and shows result
|   |   ├── 404.js              # 404 component
|   |   ├── about.js            # About component
|   |   └── navbar.js           # Navbar component
│   ├── App.js      # Main Component responsible for routing
│   ├── index.css   # Main CSS File
│   ├── theme.js    # Takes a component and applies a theme to it
│   ├── README.md   # Copy of this README file used to generate HTML for about page
│   └── ...
├── .env            # Environmental variables containing keys for API's
├── .sample_env     # An example of what .env should look like
├── README.md       # The file you are currently reading
├── run.sh          # Bash script to run the web application
└── ...