Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.92 KB

README.md

File metadata and controls

81 lines (53 loc) · 2.92 KB

Portland Public Party Finder

Created by Harold Mesa, Kelly Bruce, Helen Lehrer, Tiberius Lockett , and Noah Lundquist in September of 2022

Links

Description

Group project working with social media APIs to find events by categories in the greater Multnomah County area.

Features

  • Calls upon EventBrite and PredictHQ APIs.
  • Filters results by categories.

Technologies Used

  • Built in VS Code (v.1.70.1) using the following languages:

    • HTML
    • CSS
    • Javascript
    • Bootstrap
  • Packages used include:

    • Webpack
    • ESLint
    • Babel
    • Jest
  • Tested in the following browsers:

    • Google Chrome (v.104.0)

Installation

  • Download Git Bash

  • Input the following into Git Bash to clone this repository onto your computer:

      >git clone https://github.com/curiousmockingbird/portpubparfi
    
  • Enter the cloned project folder "portpubparfi" and type:

      >npm install
    
  • After such you can type the following command to host the site on your machine at localhost:8080 :

      >npm run start
    

The EventBrite API functionality will not be available until you do the following:

  • Sign up or Log into Eventbrite and visit your API Keys page.
  • Copy your private token.
  • Create a .env file in the root of the "portpubparfi" folder
  • Open the .env file in VS Code or the editor of your choice and input:
    BEARER_TOKEN_EB=[your EventBrite bearer-token here]

The PredictHQ API functionality will not be available until you do the following:

  • Sign up or Log into PredictHQ and visit your API Keys page.
  • Copy your private token.
  • Create a .env file in the root of the "portpubparfi" folder.
  • Open the .env file in VS Code or the editor of your choice and input:
    BEARER_TOKEN_LE=[your PredictHq bearer-token here]
    ACCESS_TOKEN=[your PredictHq access-token here]
    ACCESS_TOKEN_SECRET=[your PredictHq access-token-secret here]
    API_KEY=[your PredictHq API-key here]

Known Bugs

  • We have experimental branches for Facebook & Twitter APIs that are not functional due to authentification errors.
  • In the UI, when the height of the viewport changes size, the event result div superimposes onto the blue form div.
  • There is overflow text for the results of the PredictHQ API, so there is currently a scroll bar at the bottom of the column to account for that.
  • The Eventbrite events have to manually updated becasue the API doesn't allow for dynamic search capability.

License

Licensed under GNU GPL 3.0

Test #1