Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xrusowsky/bookmarks-to-obsidian
A lil project to sync Twitter bookmarks with an Obsidian vault.
https://github.com/0xrusowsky/bookmarks-to-obsidian
bookmarks obsidian-md twitter-api
Last synced: 17 days ago
JSON representation
A lil project to sync Twitter bookmarks with an Obsidian vault.
- Host: GitHub
- URL: https://github.com/0xrusowsky/bookmarks-to-obsidian
- Owner: 0xrusowsky
- Created: 2023-01-21T23:58:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T20:56:18.000Z (almost 2 years ago)
- Last Synced: 2024-08-08T00:44:42.861Z (4 months ago)
- Topics: bookmarks, obsidian-md, twitter-api
- Language: TypeScript
- Homepage:
- Size: 91.8 KB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- project-awesome - 0xrusowsky/bookmarks-to-obsidian - A lil project to sync Twitter bookmarks with an Obsidian vault. (TypeScript)
README
This basic local app allows you to sync your unprocessed Twitter bookmarks with your Obsidian vault.
## How does it work?
This app creates a standalone file for each bookmarked tweet. Each file has the following structure:
```
---
tags: tweet
author: author_name
date: YYYY-MM-DD
---
**Tweet URL**
https://twitter.com/jack/status/20
```
On top of that, it also maintains a file that tracks all the unprocessed bookmarks. The file has the following structure:
```
[[datetime-author]]
---
[[datetime-author]]
---
```
The idea is to delete the entries from `Unprocessed Bookmarks.md` once you have processed the standalone file that refers to the tweet (add the relevant tags, write some annotations, cross-reference it, etc.).
Every time that you sync your bookmarks, the app creates new files and entries for the tweets that belong to inexistent files.
## How to sync your bookmarks?
In the future I may create a public Obsidian plugin. But, as of now, you will have to host your own server.
#### Create a Twitter app
- If you don't have one yet, apply for a Twitter developer account [here](https://developer.twitter.com/en/portal/petition/essential/basic-info).
- Create a new app with the following settings:
- App permissions: `read`
- Type of app: `web app`
- App info: the only relevant field is the callback URI `http://127.0.0.1:5000/oauth/callback`
- Generate your keys and tokens. You will need the OAuth2.0 ones: `CLIENT_ID`, `CLIENT_SECRET`
#### Create the .env file
- Fill the information discussed in the previous step.
- Inform the `VAULT_PATH`.
#### Init the server
- Run the following command to build all the dependencies and start running the local server.
```
npm run dev
```
- Open the localhost and follow the UI.