https://github.com/cuchi/hashtrack
A simple Twitter hashtag tracking service
https://github.com/cuchi/hashtrack
graphql hacktoberfest nodejs postgresql svelte twitter-api typescript
Last synced: 12 months ago
JSON representation
A simple Twitter hashtag tracking service
- Host: GitHub
- URL: https://github.com/cuchi/hashtrack
- Owner: cuchi
- Created: 2020-01-16T23:33:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T22:27:20.000Z (over 3 years ago)
- Last Synced: 2025-04-12T15:57:02.262Z (about 1 year ago)
- Topics: graphql, hacktoberfest, nodejs, postgresql, svelte, twitter-api, typescript
- Language: TypeScript
- Homepage: https://hashtrack.herokuapp.com/
- Size: 5.41 MB
- Stars: 58
- Watchers: 2
- Forks: 9
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/nvm-sh/nvm) is recommended)
- Docker (`curl https://get.docker.com | sh`)
- [docker-compose](https://docs.docker.com/compose/install/)
### 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](./ROADMAP.md)!