An open API service indexing awesome lists of open source software.

https://github.com/terror/stream

🌊
https://github.com/terror/stream

Last synced: 4 months ago
JSON representation

🌊

Awesome Lists containing this project

README

          

## stream

[![build](https://img.shields.io/github/actions/workflow/status/terror/stream/ci.yaml?branch=master&style=flat&labelColor=1d1d1d&color=424242&logo=GitHub%20Actions&logoColor=white&label=build)](https://github.com/terror/stream/actions/workflows/ci.yaml)

**stream** is a lightweight personal micro-blogging platform I use in favour of
services like [X](https://x.com/), where I tend to get distracted easily.



## Development

You'll need [docker](https://www.docker.com/),
[cargo](https://doc.rust-lang.org/cargo/) and [npm](https://www.npmjs.com/)
installed on your machine to spawn the various components the project needs to
run locally.

First, mount a local mongodb instance with docker:

```bash
$ docker compose up -d
```

Spawn the server:

```bash
$ cargo run serve
```

Finally, spawn the react frontend:

```bash
$ npm install
$ npm run dev
```

_n.b._ Refer to `.env.dev.example` and `client/.env.dev.example` for what
environment variables need to be set.

## Prior Art

This was heavily inspired by Linus Lee's
[stream](https://stream.thesephist.com/).