tweeter

A node.js project intergrating Twitter API

About The Project

Built With

• 
• 

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Ensure that you have Node.js installed.

This project uses Twitter API. Follow this guide to register your app and get a set of keys to authenticate your API calls.

Installation

1. Make sure you got access to the Twitter API here and have registred yor app.

2. Clone the repo

   git clone https://github.com/sam959/tweeter.git

3. Install NPM packages

   npm install

4. Create an .env file in the root of the project, and write there your API key as follows:

   BEARER_TOKEN = 'ENTER YOUR API KEY';

   Optional

   You can create your .env file using

   cat > .env
   BEARER_TOKEN = 'ENTER YOUR API KEY'

   and then press CTRL+D when you're finished.

   You can specify the port where to expose your app adding

   PORT = 6060
   

   to your .env. If you do not specify a port, it defaults to 8080.

(back to top)

Usage

Run in dev mode:

npm run dev

Go to the hompage at localhost:6060 (or whatever port you specified in your .env file) and write in the text box the handle of the Twitter account you want to track.

(back to top)

Contact

Samantha - @samlovv_ - [email protected]

Project Link: tweeter

(back to top)