cobalt/README.md

61 lines
1.8 KiB
Markdown
Raw Normal View History

2022-07-08 18:17:56 +00:00
# cobalt
Sleek and easy to use social media downloader built on JavaScript. Try it out live: [co.wukko.me](https://co.wukko.me/)!
2022-07-30 09:12:32 +00:00
![cobalt logo](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/wide.png "cobalt logo")
2022-07-08 18:17:56 +00:00
## What is cobalt?
cobalt aims to be the ultimate social media downloader, that is efficient, pretty, and doesn't bother you with ads or privacy invasion agreement popups.
2022-07-08 18:17:56 +00:00
cobalt doesn't remux any videos, so you get videos of max quality available (unless you change that in settings).
2022-07-08 18:17:56 +00:00
## What's supported?
- Twitter
- TikTok
2022-07-08 18:17:56 +00:00
- YouTube and YouTube Music
- bilibili.com
- Reddit
- VK
## TO-DO
- [ ] niconico support
- [ ] douyin support
- [ ] Instagram support
2022-07-08 18:17:56 +00:00
- [ ] Quality switching for bilibili and Twitter
- [ ] Language picker in settings
- [ ] Make cobalt fully PWA compatible (add a service worker)
2022-07-08 18:17:56 +00:00
- [ ] Make switch buttons in settings selectable with keyboard
- [ ] Remake page rendering module to be more versatile
- [ ] Matching could be redone, I'll see what I can do
## Disclaimer
This is my passion project, so update scheduele depends on my motivation. Don't expect any consistency in that.
## Host an instance yourself
Code might be a little messy, but I do my best to improve it with every commit.
2022-07-08 18:17:56 +00:00
### Requirements
2022-07-08 18:18:52 +00:00
- Node.js 14.16 or above
2022-07-08 18:17:56 +00:00
- git
### npm modules
- cors
2022-07-08 18:17:56 +00:00
- dotenv
- express
2022-07-08 18:17:56 +00:00
- express-rate-limit
- ffmpeg-static
- got
2022-07-08 18:17:56 +00:00
- node-cache
- url-pattern
- xml-js
2022-07-08 18:17:56 +00:00
- ytdl-core
Setup script installs all needed **npm** dependencies, but you have to install Node.js and git yourself, if you don't have those already.
1. Clone the repo: `git clone https://github.com/wukko/cobalt`
2. Run setup script and follow instructions: `npm run setup`
3. Run cobalt via `npm start`
2022-07-08 18:17:56 +00:00
4. Done.
## License
cobalt is under [AGPL-3.0 license](https://github.com/wukko/cobalt/blob/current/LICENSE), please keep that in mind.