Skip to content

Latest commit

 

History

History
85 lines (66 loc) · 2.12 KB

README.md

File metadata and controls

85 lines (66 loc) · 2.12 KB

SentiSocial Frontend

travis coverage license: MIT code style: standard

Originally created at The University of Toronto Scarborough's Hack the Valley 2017.

SentiSocial is a Twitter based trend analysis application. This repository contains the SentiSocial frontend, which queries the backend for information related to current trends, tweets, news and sentiment values related to each one.

The data is gathered by the SentiSocial backend, which can be found here.

Prerequisites

  • git
  • Node Boron

or

  • git
  • Docker

Production

git clone https://github.com/sentisocial/frontend
cd frontend
npm install
npm run build
npm start

Alternatively, with Docker

git clone https://github.com/sentisocial/frontend
cd frontend
docker-compose up

Development

Get SentiSocial locally for development

git clone https://github.com/sentisocial/frontend
cd frontend
npm test
npm run lint # auto lint
npm run dev # hot module replacement

It will be helpful if you are familiar with the following

Feel free to contribute, by testing, documentating, developing new features, or even changing how the site looks.

Don't forget to run the tests, lint, and build the project before committing

  • npm run build
  • npm test