GUMP500 is a Twitter bot that tracks people's achievements in the Forrest Gump 500 challenge. The bot scours for tweets containing the #Gump500
and a number followed by mi
, mile(s)
, km
or kilometer(s)
. It collects the data and displays it on a webpage.
Pull requests are welcome. For major changes, please open an issue to discuss what you would like to change.
- Copy the env-sample file into a
.env
file - Run
npm install
- The project uses MongoDB as a database. To develop and test localy, you'll need one.
The easiest solution is to register a free account on MongoDB and start a free cloud server (M0 shared cluster).
Once you've done that, all you need to do is change the
MONGO_CONNECTION_URI
variable in the.env
file - You need to have a Twitter API Key to be able to fetch the tweets with hashtag
#GUMP500
(if you want to test this functionality). In order to get this, you first need an approved developer account. Once you have that, just create a new app, generate your tokens, put them in the.env
file, and off you go!