campfire/README.md

48 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2024-06-30 17:37:19 +01:00
# Campfire
2024-06-16 07:31:16 +01:00
2024-06-17 21:40:39 +01:00
social media for the galaxy-wide-web! 🌌
2024-06-30 17:37:19 +01:00
this is a *very experimental* frontend for browsing the fediverse, built
from the ground up in svelte!
2024-06-17 21:40:39 +01:00
should you choose to play around with this yourself, just know that *many
2024-06-30 17:37:19 +01:00
things are bound not to work!* notably, campfire is currently only being
battle-tested on mastodon API-compliant instances. anything beyond this
will likely be incompatible, and the web console will get very upset.
2024-06-17 21:40:39 +01:00
## features
### current
2024-06-28 08:47:02 +01:00
- infinite-scrolling feed
- log in with most/all fedi services! (with varying compatibility)
- ability to favourite, boost, and react to posts
- view threads in context
2024-07-02 20:40:50 +01:00
- notifications feed
2024-06-28 08:47:02 +01:00
- fun, clicky buttons!
2024-06-17 21:40:39 +01:00
### planned
- posting! (incl. replies and quotes)
2024-06-28 08:47:02 +01:00
- live feed
2024-06-17 21:40:39 +01:00
### "maybe"
2024-06-28 08:47:02 +01:00
- fast account switching
2024-06-17 21:40:39 +01:00
- post editing/deletion
2024-06-19 22:20:39 +01:00
- push notifications
2024-06-30 17:37:19 +01:00
- ...and potentially much more as development continues!
2024-06-17 21:40:39 +01:00
## try it out!
- `git clone` this repo
- `npm install` the dependencies
- `npm run dev` to spin up the dev environment
2024-06-30 17:37:19 +01:00
if you wish to run this in production, you need only `npm run build` and
place the static files somewhere accessible by a static webhost, such as
nginx or apache! **note:** your web server should attempt to reach
`/fallback.html` before erroring out.
have fun! ✨