Code Monkey home page Code Monkey logo

soap's Introduction

Lazy Soap

Coverage Status Build Status Go Report Card Health Status

A simple website to get the best episodes of favorite TV series. It may be helpful if you want to watch series with completely standalone episodes like "Black Mirror" as well as refresh some of the favorites series and save time.

Usage

It's publicly available at https://soap.nivoynov.dev. You also can host your instance by building/pulling the image or building binary from sources. Note that frontend statics included in the Docker image and hosted by the application itself.

You can use frontend based version https://soap.nivoynov.dev or use JSON API directly. There are only 2 methods:

  • GET /search/{query} to search id of series
{
	"searchResults": [
		{
			"id": 42009,
			"title": "Black Mirror",
			"firstAirDate": "2011-12-04",
			"poster": "https://image.tmdb.org/t/p/w92/7PRddO7z7mcPi21nZTCMGShAyy1.jpg",
			"rating": 8.3
		}
	],
	"language": "en"
}
  • GET /id/{id}?language=string to get the best episodes by id
{
	"episodes": [
		{
			"title": "The National Anthem",
			"rating": 7.504,
			"number": 1,
			"season": 1
		},
		{
			"title": "Fifteen Million Merits",
			"rating": 7.696,
			"number": 2,
			"season": 1
		},
		{
			"title": "Black Museum",
			"rating": 7.858,
			"number": 6,
			"season": 4
		}
	],
	"title": "Black Mirror",
	"poster": "https://image.tmdb.org/t/p/w92/7PRddO7z7mcPi21nZTCMGShAyy1.jpg"
}

Installation

To host your instance of app you follow these instructions. To use any option you need to obtain TMDB API Key (free).

Get pre-build image

  1. Download docker-compose.yml and etc/redis.conf.sample
  2. Consider changing settings in docker-compose.yml like listen IP/port and logging.
  3. Pull the pre build image.
    • docker-compose pull
  4. Set environment variables:
    • API_KEY to your TMDB API KEY
  5. Start services.
    • docker-compose up -d
  6. Consider setting up some https reverse proxy if you want to use it in public networks.

Build a custom image

The same steps, but instead of step 4 run docker-compose build

Build from sources

Follow the logic described in Dockerfile

soap's People

Contributors

dependabot[bot] avatar nikscorp avatar

Stargazers

 avatar  avatar

soap's Issues

Dependabot cannot be upgraded to GitHub-native version due to unsupported `dep` package manager

Dependabot Preview will be shut down on August 3rd, 2021.

It appears that this repository has configured updates for dep.

The GitHub-native version of Dependabot does not support dep, which was deprecated as of 2020.
Guidance from the dep maintainers is to upgrade to go mod, which Dependabot supports.

In order to keep getting updates for your Go dependencies, you'll need to migrate to go mod and add a Dependabot configuration for it to this repository.

[BE] Обновить контракты

Нужно обновить возвращаемые JSON хендлеров и принимаемые query параметры

  • единые правила нейминга
  • убрать imdb
  • проброс ошибок?
  • передача language от search в респонсе и принятие его в других хендлерах
  • убрать ненужные параметры, добавить новые (description)
  • нормализовать типы данных

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.