Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,25 @@ Tafkars stands for "The API formerly known as...", is written in Rust and is pro

## Help wanted

There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome!
There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome!

## Quickstart Guide

This Quickstart guide assumes you are using [this fork of libreddit](https://github.com/derivator/libreddit) and [lemmy.world](lemmy.world) to quickly get up and running with tafkars.

- Run tafkars:
- You can substitute lemmy.ml with any lemmy instance of your choice
```
git clone https://github.com/derivator/tafkars
cd tafkars
cargo run lemmy.world
```
- Run libreddit app against `127.0.0.1:8000` (default location of tafkars API):
- You can substitute this with any app that allows for a custom API URL to be passed in
```
git clone https://github.com/derivator/libreddit
cd libreddit
cargo run
```
- Visit webclient for libreddit: [http://localhost:8080/](http://localhost:8080/)
- You can substitute this with whatever app you are using.