https://github.com/hamlim/microfibre
https://github.com/hamlim/microfibre
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hamlim/microfibre
- Owner: hamlim
- Created: 2023-11-08T19:45:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T23:52:01.000Z (over 2 years ago)
- Last Synced: 2025-04-05T00:47:46.072Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://microfibre.vercel.app
- Size: 145 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Microfibre
A bare bones Go-based API (using Gin + SQLite) for creating, updating, and
reading status updates.
Think of it as a poor-mans Twitter. No social validation, no fancy features,
just a stream of updates!
## API:
- `/v1/create`
- POST request
- With post body that must at least contain a `body` field (plain text), and
can also contain a `location` field (plain text)
- `/v1/read`
- GET request
- By default get's all the updates
- `/v1/update`
- POST request
- Required:
- `?id=` query param
- Payload with any of:
- `body`
- `location`
All calls need to specify both:
- `api-version` request header, at the time of writing this is always `v1`
- A token for making the requests - open an issue if you'd like your client to
be authorized!
## Development:
To run the service locally - run `go get` and then `air`