aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1a3cf03a426fc19c9962bcc714c54867864af2b5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Twittlet
[![license](https://img.shields.io/badge/license-MIT_License_with_anime_exception-green.svg)](https://github.com/fuwn/twittlet/blob/master/LICENSE)

## Demo
<img src="https://strelizia.cc/9p0uAzxmxqUrh4FaEAGpI4PdWrx7CgF7.gif" alt="demo" width="600px">

## What?
Got a little bored and realized that I want to eventually add a downloader service to my projects site which interacts with my Twitter bot. This is in a very early stage and at the moment its just a simple Twitter media API and downloader.

## Is it done?
No.

Will probably end up adding some of the few things down below.

- [ ] YouTube + other service(s) support
- [x] Clean up codebase, namely `server.js`...
- [ ] Add handling to remove the .m3u8 file from the returned data.
- [ ] Add a method to get the size of the files (both dimensions and data size) and list that next to the links.
- [ ] Possible Bootstrap menu for cleaner look and tidy-ness.

# Setup
1. `$ npm install` to install dependencies.
2. Do `$ node server.js` to start up the app. The default localhost URL should be `http://localhost:1337`.

### Also
`app.js` is just me testing to see if this package will even work. Way cleaner than the actual `server.js` codebase so if you are going to nab this, please nab that.

### Links
* [Website](https://kyzer.co/)
* [GitHub](https://github.com/fuwn/twittlet)

### License
MIT