https://github.com/smaeda-ks/twitter-ads-api-analytics-debugger

An Electron-based desktop application for Twitter Ads Analytics API.
https://github.com/smaeda-ks/twitter-ads-api-analytics-debugger

electron twitter twitter-ads twitter-api

Last synced: 21 days ago
JSON representation

An Electron-based desktop application for Twitter Ads Analytics API.

• Host: GitHub
• URL: https://github.com/smaeda-ks/twitter-ads-api-analytics-debugger
• Owner: smaeda-ks
• License: mit
• Created: 2020-01-07T04:47:52.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T04:57:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T06:14:25.656Z (about 1 month ago)
• Topics: electron, twitter, twitter-ads, twitter-api
• Language: HTML
• Size: 691 KB
• Stars: 13
• Watchers: 3
• Forks: 2
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Twitter Ads API Analytics Debugger

An Electron-based desktop application for Twitter Ads Analytics API.

![ea4d4a412df65a6d8cd4a623fee7a710](https://user-images.githubusercontent.com/11495867/72020738-c68cc000-32af-11ea-9ad8-a8b1b0cdf5e7.gif)

## Installation

### Supported platforms

- macOS

- Windows

### Download

Please download the latest version from the [releases](https://github.com/smaeda-ks/twitter-ads-api-analytics-debugger/releases) page.  

This application is built as a single executable file so there are no "install" steps at all.

### Authentication

Please configure your OAuth 1.0a tokens by clicking the top-right button.  

Need a way to generate tokens easily? Try this tool - [tw-oob-oauth-cli](https://github.com/smaeda-ks/tw-oob-oauth-cli).



This app stores token to the system's credential storage (i.e., `Keychain` for macOS and `Credential Vault` for Windows).

## Development

### requirements

- Node.js version 12+

### npm install

```sh

$ git clone https://github.com/smaeda-ks/twitter-ads-api-analytics-debugger

$ cd ./twitter-ads-api-analytics-debugger

$ npm install

```

You probably need to run the following command after `npm install` as this app uses some native modules:

```sh

$ ./node_modules/.bin/electron-rebuild

```

### launch App

From the source directory:

```sh

$ npx electron .

```

You can also specify `--dev` option when launching. This will enable live-reloading (using [electron-reload](https://github.com/yan-foto/electron-reload)).

```sh

$ npx electron . --dev

```

### build package

If you need to build locally, try the following commands.

```sh

# macOS

$ npm run build:mac

# Windows

$ npm run build:win

# built packages are in the dist directory

$ ls ./dist

```