Skip to content

Latest commit

 

History

History
86 lines (73 loc) · 2.38 KB

README.md

File metadata and controls

86 lines (73 loc) · 2.38 KB
Raw

Streamflix

Discord

⚠️ 1.4.0 IS THE FINAL UPDATE FOR A WHILE. THE APP IS BEING REWORKED! ⚠️

I have decided to completely re-work this project, mainly because it is hard to add new features with all the useless code in this solution. I don't feel like going through each file and removing the useless code, and this gives me a chance to make a new UI that feels fresh 😃

About the project

I got tired of trying to watch stuff and constantly met with ads, so I made this program to start my journey in various tools.

Table of Contents
  1. About the Project
  2. Getting started
  3. Roadmap

Built with

Tools

Getting started

Standard Install

To install this app and get started, just go into the Releases section and download the installer.

Developer install

  1. Clone the repo
git clone https://github.com/synthofficial/streamflix
  1. Install NPM packages
npm i
  1. Create a new file in src/constants/API.ts and fill with the below
export const TVMAZE_API_KEY = 'YOUR_TVMAZE_API';
export const TVMAZE_BASE_URL = 'https://api.tvmaze.com';
export const ANIME_BASE_URL = 'https://api.ani.zip/mappings?anilist_id=';
  1. Run the program

npm

npm start

bun

bun start

yarn

yarn start

Roadmap

  • Implement movies, shows, anime
  • Implement a custom video player
  • Implement basic user settings
  • Implement custom color theme
  • Implement a login/register system to track watchlist, favourites etc.
  • Add subtitle support
  • Implement a watch together system
  • Clean up code