Georg/teddit
1
0
Fork 0
mirror of https://codeberg.org/tacerus/teddit.git synced 2025-01-09 04:42:35 +01:00
Code Issues Projects Releases Wiki Activity

Add more more details to installation instructions

Browse Source
This commit is contained in:
amrw 2020-12-09 23:03:17 +01:00
parent ef683d0687
commit 0149d4704d
No known key found for this signature in database
GPG Key ID: BDE4B0FDD8FA1C85
1 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,9 +1,7 @@
# teddit # teddit
[teddit.net](https://teddit.net) [teddit.net](https://teddit.net)
A free and open source alternative Reddit front-end focused on privacy. A free and open source alternative Reddit front-end focused on privacy.
Inspired by the [Nitter](https://github.com/zedeus/nitter) project. Inspired by the [Nitter](https://github.com/zedeus/nitter) project.
@ -50,23 +48,41 @@ Community instances:
### Docker ### Docker
Using [`docker-compose`](https://github.com/docker/compose): Using [Docker and `docker-compose`](https://github.com/docker/compose):
```bash
```console
docker-compose build docker-compose build
docker-compose up docker-compose up
``` ```
Teddit should now be running at <https://localhost:8080>.
### Manual ### Manual
1. Install [node.js](https://nodejs.org/en/) 1. Install [Node.js](https://nodejs.org).
1. It's highly recommended that you install [redis-server](https://redis.io/) because it works as a cache for Reddit API calls. If you want to support videos, install [ffmpeg](https://ffmpeg.org/)\ 1. (Optional) Install [redis-server](https://redis.io).
For example:\
`# apt install redis-server ffmpeg`
1. `$ git clone https://codeberg.org/teddit/teddit`
1. `$ cd teddit`
1. `$ npm install --no-optional`
1. Copy `config.js.template` to `config.js` and then edit it to suit your environment.
1. `$ npm start`
Teddit should be now running. Highly recommended – it works as a cache for Reddit API calls.
1. (Optional) If you want to support videos, install [ffmpeg](https://ffmpeg.org)
```console
# Linux
apt install redis-server ffmpeg
# macOS
brew install redis
```
1. Clone and set up the repository.
```console
git clone https://codeberg.org/teddit/teddit
cd teddit
npm install --no-optional
cp config.js.template config.js # edit the file to suit your environment
redis-server
npm start
```
Teddit should now be running at <https://localhost:8080>.