Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashmeh/finch
Multi-lingual tweet entities and tweet sentiment extractor using aws comprehend :bird: :book: :bird:
https://github.com/yashmeh/finch
hacktoberfest
Last synced: about 11 hours ago
JSON representation
Multi-lingual tweet entities and tweet sentiment extractor using aws comprehend :bird: :book: :bird:
- Host: GitHub
- URL: https://github.com/yashmeh/finch
- Owner: YashMeh
- License: mit
- Created: 2020-07-20T14:16:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T14:19:07.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T14:43:34.313Z (over 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 429 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Finch
Finch is a multi-lingual tweet parsing tool which gives the entities involved in the tweet and the sentiment of the tweet,in addition to all the information provided by the Twitter-API.
   
### Languages Supported
Hindi, English, Korean, Chinese, German, Italian, French, Arabic
### Architecture :building_construction:
### How to setup :computer:
#### Twitter keys :key:
- Make a developers account on twitter and get the access keys and secret tokens for your app.
#### AWS keys :key:
- Create a programmatic user using IAM
- Give the user read/write access to the comprehend service
### How to run :runner:
There are 2 methods to run the project
1. Using Docker (Easiest) :whale:
- Just edit the `docker-compose.yml` file and add the required keys.
- The images are auto-built and can be found at [Docker Hub](https://hub.docker.com/u/yashmeh)
2. Individual Setup :bearded_person:
- Download and install the NATS server, mongoDB and nodeJS (v>=8.x).
- Install dependencies inside comprehend-service and twitter-service using `npm install`.
- Add a `.env` file to the services and add your keys and configurations.
- .env for twitter-service
```
NATS_URL=
CONSUMER_KEY=
CONSUMER_SECRET=
ACCESS_TOKEN=
ACCESS_TOKEN_SECRET=
TAG=
```
- .env for comprehend-service
```
NATS_URL=
ACCESS_KEY=
SECRET_ACCESS=
```
- Run using `node .js`
- Checkout the database at `http://localhost:5000/api/v1`
- By default,all your previous tag data is saved in a DB volume named finch_data-db. Thus, in case you want to start from a fresh DB
- Delete the volume using
```
docker volume rm finch_data-db -f
```
### Output
### Work Left :man_factory_worker:
- [ ] Add exhaustive tests
- [ ] Build a GUI to convert this to a CRM tool.
> Finch fetches the tag given in the .env file every 5 minutes and updates the database
## Stargazers over time
[](https://starchart.cc/YashMeh/finch)
### Yash Mehrotra
 
---
```C++
if(repo.isAwesome || repo.isHelpful){
StarRepo();
}
```