richdurazo / top-tweets

Top Tweet Challenge

A simple application that integrates with the Tritter API in order to provide an easy way to search Twitter for keywords and retrieve a listing of the top 5 tweets, ordered by most popular, so the trends and hashtags can be monitored.

Server

Located in the Root directory (index.js) simple server build with expressJs in order to Proxy the Twitter API as this API does not support CORS.

Client

Located in the client directory and initialized in /src/index.js. A single page application build on react and webpack. This application leverages the Twitter API - Standard v1.1

Installation

Server Installation

in the root directory run:

npm install

Client Installation

then cd into the client directory and run:

npm install

Running the application

*Important -> the server leverages dotenv in order to not expose sensitive information to sorce control. please add a .env file to the root directory with REQUEST_URL and TOKEN

commands must be run in the root directory

client and server at the same time

npm run dev

http://localhost:8080/

running server only

npm run server

http://localhost:5000/

running client only

npm run client

http://localhost:8080/

testing the application

cd into the client directory

npm run test

top-tweets's Issues

FED-1

• add webpack starter config for react application

FED-3

Add tests for extra credit and deploy application

FED-2

• create initial app components/styling
• search component
• connect Twitter api
• cors proxy