Skip to content
forked from jonhue/plaain

Stream your media from anywhere. No server. No fee.

License

Notifications You must be signed in to change notification settings

antonbaumann/plaain

 
 

Repository files navigation

Plaain

Stream your media from anywhere. No server. No fee. Plaain works by connecting your device directly to the cloud where your media is hosted. It then stores metadata to all your movies & TV shows on your device.

Supported cloud providers

  • OneDrive
  • Dropbox (on the roadmap)
  • Google Drive (on the roadmap)

Getting started

In your cloud you have to organize your files a certain way so that they are found by Plaain.

  1. Create a root folder called Plaain.
  2. Create the subfolders Movies and Shows
  3. Within Movies, create a folder for every movie you want to add to Plaain with the movies title as its name.
  4. Within Shows, create a folder for each TV show you intend to add to Plaain with the shows title as its name. Then create a subfolder for each season (use the season number as name, e.g. 1). Yet one level deeper, create a subfolder for each episode (use the episode number as name).
  5. Within every folder for a watchable item (movie/episode), add your source files. Allowed file types for videos are mp4, m4v, kmv and webm. The only allowed file type for subtitles is vtt. You'll later be able to switch between the uploaded video sources and subtitles by filename.

A file structure could look like this:

Plaain
|--Movies
|--|--Argo
|--|--|--1080.mp4
|--|--|--720.mp4
|--|--|--English.vtt
|--Shows
|--|--Game of Thrones
|--|--|--1
|--|--|--|--1
|--|--|--|--|--1080.mp4
|--|--|--|--2
|--|--|--|--|--1080.mp4

To get started, launch Plaain and authenticate with your cloud provider. Now enjoy your favorite movies & TV shows!

Note: In the case that one of your movies/shows isn't added to Plaain even though it is located in your cloud, ensure that you can find the title on https://www.themoviedb.org/ by the name of the directory.

Features

Stream anywhere

Stream your media library from wherever you are, with any device. Plaain is a Progressive Web App that runs in your browser and still feels like a native app.

No server

You don't need to setup your own media server to run 24/7 with Plaain. Plaain just needs access to your personal cloud provider.

Privacy first

Plaain runs in your browser. All the data it stores is kept locally on your device.

Built using modern tools

Plaain is built as a Progressive Web App with React & Redux. It uses TMDb to fetch metadata on your movies & tv shows.

Development

This project uses asdf as version manager and Yarn as JavaScript package manager.

Dependencies are listed in the .tool-versions file.

  1. Clone this repository

    $ git clone ssh://[email protected]/jonhue/plaain.git

  2. Install dependencies

    $ asdf install
    $ yarn install
    
  3. Start the development server

    $ yarn start

Testing

This project uses a react-scripts for testing and ESLint and StyleLint for linting:

yarn eslint
yarn stylelint
yarn test

Deployment

Plaain is hosted on GitHub Pages.

To deploy, run:

$ yarn build
$ yarn deploy

About

Stream your media from anywhere. No server. No fee.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 82.2%
  • CSS 15.8%
  • HTML 2.0%