Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 986 Bytes

README.md

File metadata and controls

36 lines (25 loc) · 986 Bytes
Raw

Hashtrack

Hashtrack is a web application that tracks Twitter hashtags.

The purpose of this project is to build a maintainable easy-to-deploy fullstack web application from the ground up.

Run locally

Prerequisites

  • Node.js (nvm is recommended)
  • Docker (curl https://get.docker.com | sh)
  • docker-compose

Steps

  1. yarn
  2. yarn start

The start script will create all the local services needed to run it in development mode. The application will be available in http://localhost:8080 by default.

You should create a .env file with your API and consumer tokens if you want to see real tweets (see .env.example).

The automated tests can be run with yarn test, this will also wind up some needed local services first.

There are still improvements to be made. Check out the roadmap!