Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mtlynch/screenjournal

Like Goodreads but for couch potatoes
https://github.com/mtlynch/screenjournal

golang movies reviews

Last synced: 11 days ago
JSON representation

Like Goodreads but for couch potatoes

Awesome Lists containing this project

README

        

# ScreenJournal

[![CircleCI](https://circleci.com/gh/mtlynch/screenjournal.svg?style=svg)](https://circleci.com/gh/mtlynch/screenjournal)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/mtlynch/screenjournal)](https://github.com/mtlynch/screenjournal/commits/master)
[![GitHub last commit](https://img.shields.io/github/last-commit/mtlynch/screenjournal)](https://github.com/mtlynch/screenjournal/commits/master)
[![Contributors](https://img.shields.io/github/contributors/mtlynch/screenjournal)](https://github.com/mtlynch/screenjournal/graphs/contributors)
[![License](http://img.shields.io/:license-agpl-blue.svg?style=flat-square)](LICENSE)

Like Goodreads but for couch potatoes

## Overview

ScreenJournal lets you rate movies you've seen and share movie recommendations with friends.

## Development status

ScreenJournal is in pre-alpha state and is not yet documented for other people to use it. If you can figure out how to use it, you're welcome to play around. I'm planning to get it to the point where it's useful to others soon.

## Parameters

### Command-line flags

| Flag | Meaning | Default Value |
| ----- | ----------------------- | ----------------- |
| `-db` | Path to SQLite database | `"data/store.db"` |

### Environment variables

| Environment Variable | Meaning |
| -------------------- | --------------------------------------------------------------------------------------------------------------- |
| `PORT` | TCP port on which to listen for HTTP connections (defaults to 3001). |
| `SJ_TMDB_API` | (required) API key for TMDB. You can obtain a free key at [TMDB](https://www.themoviedb.org/documentation/api). |
| `SJ_BEHIND_PROXY` | (optional) Set to `"true"` to improve logging when ScreenJournal is running behind a reverse proxy. |
| `SJ_SMTP_HOST` | (optional) Hostname of SMTP server to send notifications. |
| `SJ_SMTP_PORT` | (optional) Port of SMTP server to send notifications. |
| `SJ_SMTP_USERNAME` | (optional) Username for SMTP server to send notifications. |
| `SJ_SMTP_PASSWORD` | (optional) Password for SMTP server to send notifications. |
| `SJ_BASE_URL` | (optional) Base URL of ScreenJournal server (only used for notifications). |