cohost-blogger/README.md

42 lines
1.5 KiB
Markdown
Raw Normal View History

2023-04-30 21:49:07 +02:00
# cohost-blogger
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
A self-hostable front-end for [Cohost](https://cohost.org/) mimicing a CMS.
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
## What?
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
CMSes are stupid to host, stupid to make and stupid to find. Why bother? We have a perfectly fine Cohost. Let's use that!
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
This site, pointed at a Cohost user and tag, will find every post under that tag and display it in a nice way, including the comments and proper rendering of the contents themselves.
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
## How?
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
_If you're on NixOS, you should be able to integrate it into your [system config as a flake](https://git.oat.zone/dark-firepit/dotfiles/commit/26552bfb01e487fbabcdd6f72f2a1f1a0eb56cd2) or just run it with `nix run`._
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
First, install the dependencies:
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
```sh
git clone https://git.oat.zone/oat/cohost-blogger && cd cohost-blogger
npm install
2023-04-30 18:33:19 +02:00
```
2023-04-30 21:49:07 +02:00
Afterwards, for development, you can run:
```
npm run dev
```
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
Or, for deployment:
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
```
2023-04-30 18:33:19 +02:00
npm run build
2023-04-30 21:49:07 +02:00
PORT=1234 node build
2023-04-30 18:33:19 +02:00
```
2023-04-30 21:49:07 +02:00
## Configuration
Currently, there isn't a proper configuration system - this is not yet made to be hosted by anyone by me. You can head into [`src/lib/config.js`](https://git.oat.zone/oat/cohost-blogger/src/lib/config.js) for all instance-specific configuration, but this will be expanded into a proper system eventually:tm.
## Attributions
2023-04-30 18:33:19 +02:00
2023-04-30 21:49:07 +02:00
- **[@mintexists](https://cohost.org/mintexists)**, for help reverse-engineering the Cohost API
- **[Cohost's devteam](https://cohost.org/staff)** - while this site does interact _with_ Cohost, lots of the [Markdown processing code](https://git.oat.zone/oat/cohost-blogger/src/branch/main/src/lib/markdown) is borrowed from their sourcemaps