# electron-twitter-tools

> An Electron/Vue Twitter client for the power user.

Latest version **0.2.3** (published 2019-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install electron-twitter-tools
pnpm add electron-twitter-tools
yarn add electron-twitter-tools
bun add electron-twitter-tools
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2019-08-13 |
| First published | 2018-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 30 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 (+28 in 3 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 5 |
| Author | Tom Shaw |
| Maintainers | urlrider |
| Keywords | electron, twitter, vue |

## Links

- npm: https://www.npmjs.com/package/electron-twitter-tools
- Repository: https://github.com/tomshaw/electron-twitter-tools
- Homepage: https://github.com/tomshaw/electron-twitter-tools#readme
- Issues: https://github.com/tomshaw/electron-twitter-tools/issues
- npm.io page: https://npm.io/package/electron-twitter-tools

## Dependencies (30)

- [d3](https://npm.io/package/d3.md) ^5.0.0
- [pg](https://npm.io/package/pg.md) ^7.4.1
- [vue](https://npm.io/package/vue.md) ^2.4.2
- [knex](https://npm.io/package/knex.md) ^0.14.2
- [vuex](https://npm.io/package/vuex.md) ^2.3.1
- [axios](https://npm.io/package/axios.md) ^0.19.0
- [mssql](https://npm.io/package/mssql.md) ^4.1.0
- [mysql](https://npm.io/package/mysql.md) ^2.15.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [moment](https://npm.io/package/moment.md) ^2.20.1
- [sqlite3](https://npm.io/package/sqlite3.md) ^4.0.9
- [twemoji](https://npm.io/package/twemoji.md) ^2.5.0
- [twitter](https://npm.io/package/twitter.md) ^1.7.1
- [vuetify](https://npm.io/package/vuetify.md) ^1.0.4
- [chart.js](https://npm.io/package/chart.js.md) ^2.7.2
- [chartist](https://npm.io/package/chartist.md) ^0.11.0
- [mariasql](https://npm.io/package/mariasql.md) ^0.2.6
- [amcharts3](https://npm.io/package/amcharts3.md) ^3.21.12
- [wordcloud](https://npm.io/package/wordcloud.md) ^1.1.0
- [dateformat](https://npm.io/package/dateformat.md) ^3.0.2
- [vue-router](https://npm.io/package/vue-router.md) ^2.5.3
- [vue-toastr](https://npm.io/package/vue-toastr.md) ^2.0.12
- [big-integer](https://npm.io/package/big-integer.md) ^1.6.26
- [fontawesome](https://npm.io/package/fontawesome.md) ^4.7.2
- [vue-chartjs](https://npm.io/package/vue-chartjs.md) ^3.2.1
- [twitter-text](https://npm.io/package/twitter-text.md) ^2.0.4-rc1
- [vue-electron](https://npm.io/package/vue-electron.md) ^1.0.6
- [electron-settings](https://npm.io/package/electron-settings.md) ^3.1.4
- [@deveodk/vue-toastr](https://npm.io/package/@deveodk/vue-toastr.md) ^1.0.4
- [electron-context-menu](https://npm.io/package/electron-context-menu.md) ^0.9.1

## Recent versions

- 0.2.3 (latest) — 2019-08-13
- 0.2.2 — 2019-08-13
- 0.2.1 — 2018-04-01
- 0.2.0 — 2018-03-30
- 0.1.9 — 2018-03-26
- 0.1.8 — 2018-03-24
- 0.1.7 — 2018-03-24
- 0.1.6 — 2018-03-23
- 0.1.5 — 2018-03-23
- 0.1.4 — 2018-03-21
- 0.1.3 — 2018-03-21
- 0.1.2 — 2018-03-20
- 0.1.1 — 2018-03-20
- 0.1.0 — 2018-03-19

## README

<h1><img src="https://raw.github.com/tomshaw/electron-twitter-tools/master/docs/logo.png" alt="Electron Twitter Tools" title="Electron Twitter Tools"></h1>

[![Build Status](https://travis-ci.org/tomshaw/electron-twitter-tools.svg?branch=master)](https://travis-ci.org/tomshaw/electron-twitter-tools)
[![Tag](https://img.shields.io/github/tag/tomshaw/electron-twitter-tools.svg)](https://github.com/tomshaw/electron-twitter-tools/tags)
[![GitHub (pre-)release](https://img.shields.io/github/release/tomshaw/electron-twitter-tools/all.svg)](https://github.com/tomshaw/electron-twitter-tools/releases)
[![Version npm](https://img.shields.io/npm/v/electron-twitter-tools.svg)](https://www.npmjs.com/package/electron-twitter-tools)
[![Downloads npm](https://img.shields.io/npm/dt/electron-twitter-tools.svg)](https://www.npmjs.com/package/electron-twitter-tools)
[![MIT license](https://img.shields.io/npm/l/electron-twitter-tools.svg)](https://opensource.org/licenses/MIT)
[![GitHub stars](https://img.shields.io/github/stars/tomshaw/electron-twitter-tools.svg?style=social&label=Star)](https://github.com/tomshaw/electron-twitter-tools)

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

## Overview

> Electron Twitter Tools a cross platfom [Electron](https://electronjs.org) application that allows users to effortlessly backup and restore user lists, seamlessly manage friends and followers, perform powerful multi account user searches and finally execute highly customized streaming searches that index a litany of data including languages used, geographic locations and rudimentary sentiment analysis.

## Screen Shots
As part of the documentation you can check out more [random screenshots here.](docs/screenshots/readme.md)

<img src="docs/screenshots/screen-grab1.png" alt="Electron Twitter Tools" title="Electron Twitter Tools">

## Build Setup
Once the application is launched you will need to provide your own Twitter API keys in the application configuration panel. An Sqlite3 database comes pre-selected and ready to use by default. A Google Maps API key is also required and can also be added in the application settings control panel.

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:9080
npm run dev

# build electron application for production
npm run build

# run unit & end-to-end tests
npm test

# lint all JS/Vue component files in `src/`
npm run lint

```

## Features

Functionality you'll find in this application include:

- User list management including backup and restore options.
- A highly customized streaming search that indexes a litany of data.
- A multi user account lookup that returns most of the relevant metadata. 
- Delete user statuses tweets and favorites based on search criteria.
- Supports multiple storage backends special thanks to [Knex.js](http://knexjs.org/)

## Libraries Used

+ [Electron](https://electronjs.org) - Build cross platform desktop apps with JavaScript, HTML, and CSS.
+ [Electron Vue](https://github.com/SimulatedGREG/electron-vue) - An Electron & Vue.js quick start boilerplate with vue-cli
+ [Vue](https://vuejs.org) - A progressive, JavaScript framework for building UI on the web.
+ [Vuex](https://vuex.vuejs.org/en) - Vuex is a state management pattern + library for Vue.js applications..
+ [Vuetify](https://vuetifyjs.com/en) - Vuetify is a semantic material component framework for Vue.js.
+ [VueChart.js](http://vue-chartjs.org) - Easy and beautiful charts with Chart.js and Vue.js.
+ [Knex.js](http://knexjs.org/) - An SQL query builder designed to be flexible, portable, and fun to use.

## Contributing
The project was originaly developed to learn the basics of [Electron](https://electronjs.org), [Vue](https://vuejs.org), [Vuex](https://vuex.vuejs.org/en) and [Vuetify](https://vuetifyjs.com/en) and was developed rather hastily. Many of the components are incomplete or could use vast improvements. Any pull requests, suggestions or ideas are highly welcomed.

## AFINN

This project makes use of [AFINN](http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6010) a list of English words rated for valence with an integer between minus five (negative) and plus five (positive). The words have been manually labeled by Finn Årup Nielsen in 2009-2011. This database of words is copyright protected and distributed under the [Open Database License (ODbL) v1.0](http://www.opendatacommons.org/licenses/odbl/1.0).

## License

See the bundled LICENSE file for details.

## Author

Tom Shaw (@urlrider)

---
_Source: https://npm.io/package/electron-twitter-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
