https://github.com/mshenfield/tuck-town

Find the RuPaul's Drag Race contestants closest to you.
https://github.com/mshenfield/tuck-town

Last synced: about 13 hours ago
JSON representation

Find the RuPaul's Drag Race contestants closest to you.

• Host: GitHub
• URL: https://github.com/mshenfield/tuck-town
• Owner: mshenfield
• Created: 2019-01-06T19:42:43.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-06-27T06:16:14.000Z (over 4 years ago)
• Last Synced: 2024-06-11T20:34:57.533Z (5 months ago)
• Language: JavaScript
• Homepage: https://tuck.town
• Size: 6.34 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tuck Town

Find the RuPaul's Drag contestant closest to you.

This is still very much a WIP - stay tuned.

## Running

This can be run using the following commands:

```bash

REACT_APP_GOOGLE_API_KEY= yarn start

```

See the [Google API Setup][#google-api-setup] section to set up your API key.

### Additional Commands

See the [Create React App Guide](./CREATE_REACT_APP_GUIDE.md) for a full list of commands.

## Setup

### Generating queens.json

Follow the instructions in `scripts/scrape-queens-data.py` to generate or add to `queens.json`. Make sure to copy the file to `src/queens.json` for it to be added to the project.

WARNING: The above script is only compatible with `python3`.

### Google API Setup

This project utilizes the Google Places Autocomplete widget, and the Google Distance Matrix API. To setup:

* Go to your project's page in [the Google Cloud Console](console.cloud.google.com)

* Go to the [API's Dashboard](https://console.cloud.google.com/apis/dashboard) for your project

* Click "+ Enable APIs and Services"

* Search for and enable the following APIs

    * Maps JavaScript API

    * Places API for Web

* Navigate to the "Credentials" menu

* Follow steps to "Create credentials", making sure to select "API Key" from the dropdown.

WARNING: Enabling an API key _will_ charge money if you exceed the $200 usage limit. Please follow best practices for [securing and limiting usage of your API key](https://support.google.com/cloud/answer/6310037?hl=en_US). There are serious financial risks if someone steals an unsecured API key.

You can use the created API as the `REACT_APP_GOOGLE_API_KEY` in the [run command above](#running). You can also add your key to the .gitignor-ed `.env.local` file or use any of the [methods described here](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell) to set it.

### Regenerating `cityCoords.json`

`cityCoords.json` contains lat/lng coordinates for each city name that appears in `queens.json`.  New seasons may contain new cities. Grab the lat/lng any new cities by using any online address to lat/long tool. The original coords were generated using the Google Maps Geocoding API in the developer console.

## Deployment

`yarn run deploy`. You must have access to the gh-pages branch of the repository for this command to be succesful.

## Tests 

None yet 🐛🐛🐛

## License

[MIT](LICENSE)