README.md

twitter2pg

Richard Wen
rrwen.dev@gmail.com

Module for extracting Twitter data to PostgreSQL databases

Test Environment

The test environment creates an isolated PostgreSQL database named twitter2pg_database to run tests on.

To connect to Twiter and PostgreSQL, a .env file is required:

1. Create a .env file in the root directory
2. Use the template below to provide Twitter credentials and PostgreSQL connection details inside the .env file

TWITTER_CONSUMER_KEY=***
TWITTER_CONSUMER_SECRET=***
TWITTER_ACCESS_TOKEN_KEY=***
TWITTER_ACCESS_TOKEN_SECRET=***
PGHOST=localhost
PGPORT=5432
PGTESTDATABASE=twitter2pg_database
PGUSER=super_user
PGPASSWORD=***

The Tests can then be run with the following command:

npm test