Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DracoBlue/twtxt-registry
A small registry server for twtxt, which allows to query for mentions and hash tags.
https://github.com/DracoBlue/twtxt-registry
Last synced: 5 days ago
JSON representation
A small registry server for twtxt, which allows to query for mentions and hash tags.
- Host: GitHub
- URL: https://github.com/DracoBlue/twtxt-registry
- Owner: DracoBlue
- Created: 2016-02-11T14:16:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T01:33:08.000Z (5 months ago)
- Last Synced: 2024-08-01T12:30:38.877Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 505 KB
- Stars: 18
- Watchers: 6
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - DracoBlue/twtxt-registry - A small registry server for twtxt, which allows to query for mentions and hash tags. (others)
README
# Twtxt Registry Server
A small registry server for twtxt, which allows to query for mentions and hash tags.
## Prerequisites
* [gcp firestore in datastore mode](https://cloud.google.com/datastore/docs)
* [npm](https://nodejs.org) installed
## Installation
Set up the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to a user (or use gcloud auth login) for a gcp datastore project.
Replace `$GOOGLE_PROJECT_NAME` with your google project name.
``` console
$ npm install
$ export PORT=8080
$ export START_UPDATING=1
$ export UPDATING_INTERVAL=900
$ gcloud datastore indexes create --project $GOOGLE_PROJECT_NAME index.yaml
Configurations to update:
descriptor: [index.yaml]
type: [datastore indexes]
target project: [your-project-name]
Do you want to continue (Y/n)? y
....done.
$ node src/server.js
```
## Example API calls for the Plain-Text-Api
You can see a demo running at and a swagger-ui api doc at .
Add a new Twtxt User to the Registry:
``` console
$ curl -X POST 'http://localhost:8080/api/plain/users?url=https://dracoblue.net/twtxt.txt&nickname=dracoblue'
OK
```
See latest tweets in the Registry (e.g. ):
``` console
$ curl 'http://localhost:8080/api/plain/tweets'
dracoblue https://dracoblue.net/twtxt.txt 2016-02-06T21:32:02.000Z @erlehmann is messing with timestamps in @buckket #twtxt :)
dracoblue https://dracoblue.net/twtxt.txt 2016-02-06T12:14:18.000Z Simple nodejs script to convert your twitter timeline to twtxt: https://t.co/txnWsC5jvA ( find my #twtxt at https://t.co/uN1KDXwJ8B )
```
Search for tweets in the Registry (e.g. ):
``` console
$ curl 'http://localhost:8080/api/plain/tweets?q=twtxt'
buckket https://buckket.org/twtxt.txt 2016-02-09T12:42:26.000Z Do we need an IRC channel for twtxt?
buckket https://buckket.org/twtxt.txt 2016-02-09T12:42:12.000Z Good Morning, twtxt-world!
```
Retrieve a list of all mentions of a specific twtxt User like `https://buckket.org/twtxt.txt` (e.g. ):
``` console
$ curl 'http://localhost:8080/api/plain/mentions?url=https://buckket.org/twtxt.txt'
dracoblue https://dracoblue.net/twtxt.txt 2016-02-09T12:57:59.000Z @ something like https://gitter.im/ or a freenode channel?
dracoblue https://dracoblue.net/twtxt.txt 2016-02-08T22:51:47.000Z @ looks nice ;)
```
Retrieve a list of all tweets with a specific tag like `#twtxt` (e.g. ):
``` console
$ curl 'http://localhost:8080/api/plain/tags/twtxt'
dracoblue https://dracoblue.net/twtxt.txt> 2016-02-06T21:32:02.000Z @erlehmann is messing with timestamps in @buckket #twtxt :)
dracoblue https://dracoblue.net/twtxt.txt> 2016-02-06T12:14:18.000Z Simple nodejs script to convert your twitter timeline to twtxt: https://t.co/txnWsC5jvA ( find my #twtxt at https://t.co/uN1KDXwJ8B )
```
Search for users in the Registry (e.g. ):
``` console
$ curl 'http://localhost:8080/api/plain/users?q=dracoblue'
https://dracoblue.net/twtxt.txt 2016-02-09T12:42:26.000Z dracoblue
```
## License
This work is copyright by DracoBlue (http://dracoblue.net) and licensed under the terms of MIT License.