NyumatFlix is a platform for streaming movies and TV shows. It is a open-source, no-cost, and ad-free movie and tv show stream aggregator. Streams are curated from some of the most popular API providers.

• Bun
• Next.js
• Resend
• TypeScript
• Postgres
• Shadcn UI
• Husky
• Drizzle ORM
• Jest
• NextAuth.js
• TMDb API
• Biome

To run the project on your machine, follow the steps below:

1. Clone or fork the repository

git clone git@github.com:Nyumat/NyumatFlix.git
cd NyumatFlix

2. Next, create a .env.local file in the root directory of the project and add the following environment variables:

TMDB_API_KEY=
AUTH_SECRET=
AUTH_RESEND_KEY=
AUTH_URL=
PROD_DATABASE_URL=
DATABASE_URL=

You can get your own instance of the API keys by creating an account on TMDb and Resend.

For the database, you can use any PostgreSQL database you want. I recommend using Neon for production and Local Postgres for development.

For the GitHub OAuth app, you can create one by following the instructions here!

3. Install dependencies

NyumatFlix is primarily built using Bun, so you'll need to install it first. You can do so by following the instructions here.

bun install

4. Configure magic strings

There's a few places in the codebase where I'm hardcoding some strings that you might want to change. You can find some of them in lib/constants.ts. Additionally, you might want to modify the email templates in emails/ and metadata objects in app/ and layout/.

If you end up not changing the magic strings, that's fine too, but I'd appreciate credit if you re-deploy NyumatFlix without modifications!

5. Set up the database

bun run db:generate
bun run db:push
bun run db:studio # optional

These will generate the necessary migration files and push the schema to your PostgreSQL database. You can optionally use bun run db:studio to open Drizzle's database studio to visualize the DB internals.

6. Run the development server

bun run dev

7. Finally, open http://localhost:3000 in your browser to see NyumatFlix in action!

NyumatFlix, duh! (But let's be real, there's 1000s of us aggregators - which makes this site's personal touch all the more special!)

Stream providers (also called video servers) are the services that actually serve the video content. To add a new stream provider, you need to add it to the videoServers array in lib/stores/server-store.ts.

Each stream provider must implement the VideoServer interface, which includes:

• id: A unique identifier for the provider (e.g., "vidsrc")
• name: Display name for the provider (e.g., "VidSrc")
• baseUrl: Base URL of the provider's service
• getMovieUrl(tmdbId): Function that returns the embed URL for a movie
• getTvUrl(tmdbId): Function that returns the embed URL for a TV show
• getEpisodeUrl(tmdbId, season, episode): Function that returns the embed URL for a specific episode
• Optional: getAnimeUrl, getAnimePaheUrl, getVidnestUrl for anime support
• Optional: checkAvailability and checkIndividualAvailability for availability checking

Here's an example of adding a new provider:

{
  id: "myprovider",
  name: "My Provider",
  baseUrl: "https://myprovider.com",
  getMovieUrl: (tmdbId) => `https://myprovider.com/embed/movie/${tmdbId}`,
  getTvUrl: (tmdbId) => `https://myprovider.com/embed/tv/${tmdbId}`,
  getEpisodeUrl: (tmdbId, season, episode) =>
    `https://myprovider.com/embed/tv/${tmdbId}?s=${season}&e=${episode}`,
}

Add this object to the videoServers array in lib/stores/server-store.ts. The provider will automatically be available in the application's server selection UI.

When running the application in development mode (NODE_ENV=development), authentication works differently than in production:

1. Start the development server:

   bun run dev

2. Navigate to the login page at http://localhost:3000/login

3. Enter your email address and submit the form

4. Check your terminal/console - Instead of sending an email, the magic link will be logged directly to your terminal with a formatted output like this:

   ============================================================
   🔐 MAGIC LINK FOR DEVELOPMENT
   ============================================================
   📧 Email: your-email@example.com
   🔗 Magic Link: http://localhost:3000/api/auth/callback/resend?...
   ============================================================
   ⚠️  Development mode: Email not sent. Use the link above to sign in.
   ============================================================
   

5. Automatic redirect - In development mode, you'll be automatically redirected to the callback URL and signed in. The link is also logged to the terminal in case you need to manually access it or if the redirect doesn't work

Contributions, feedback, and suggestions are always welcome. If you have any questions, feel free to open an issue. I can't guarantee I'll be able to address everything as a solo dev (on top of juggling other commitments), but I'll do my best!

If you find NyumatFlix useful, consider starring the repo! I appreciate all the support and feedback I've received from the community over the years developing this project.