+
Skip to content

A snappy, customizable video feed. Designed to show you exactly the content you want to see and nothing else.

License

Notifications You must be signed in to change notification settings

hfellerhoff/serial

Repository files navigation

Preview of different feeds

Serial

A snappy, customizable video feed. Designed to show you exactly the content you want to see and nothing else.

Check it out →

Releases & Changelog

All release notes can be found at https://serial.tube/releases.

Local Development

Note: Local development is only possible through the libsql host Turso at the moment. This will change going forward, but keep in mind that your current database choices may be limited.

Getting up and running with Serial is easy. Here are the steps you need to start developing locally:

  1. Clone the repository locally
  2. Duplicate the .env.example file, and rename the copy to .env
  3. Create a new database on Turso
    1. Sign up for an account if you don't have one, and navigate to the database dashboard
    2. Create a new database
    3. In the top right dropdown menu, click "Create Token"
    4. Create a token with read and write permissions
    5. On the success screen, save the top value as DATABASE_AUTH_TOKEN and the bottom as DATABASE_URL
  4. Navigate to Better Auth and generate an auth secret. Set this as BETTER_AUTH_SECRET
  5. (optional) Create an account on Sendgrid and set up a mailing address.
    • This is not necessary to get up and running, but is needed if you'd like working password reset and other email-related functionality.
  6. Install your packages with pnpm
    1. If you don't have it already, install pnpm
    2. Run pnpm i to install packages
  7. That's it! Run pnpm dev to migrate your database for the first time and boot up the development server.

Self Hosting

Note: Self hosting is only possible through the libsql host Turso at the moment. This will change going forward, but keep in mind that your current database choices may be limited.

Self hosting Serial is relatively easy. I'll use the platform Vercel here as an example (since it's easy to deploy Next.js applications there) but many platforms should work.

If you'd like a deployment target with more ownership that's still relatively easy to use, I would recommend Coolify. I use it to run the main Serial instance.

On Vercel, follow these steps:

  1. Fork the hfellerhoff/serial respository to your own GitHub account.
  2. Login to Vercel and follow the onboarding to link your GitHub account.
  3. Choose the serial repository and hit deploy. Your initial deployment will fail – that's okay.
  4. Within your project, navigate to Settings > Domains. You have a few options for project domains:
    1. You can copy the provided domain as is
    2. You can update the provided domain with a new name
    3. You can link an existing domain
  5. Whichever domain you choose, copy that name and head down to Environment Variables. Add that domain value as NEXT_PUBLIC_ROOT_URL, being sure to include the protocol (https://)
  6. Create a new database on Turso
    1. Sign up for an account if you don't have one, and navigate to the database dashboard
    2. Create a new database
    3. In the top right dropdown menu, click "Create Token"
    4. Create a token with read and write permissions
    5. On the success screen, save the top value as DATABASE_AUTH_TOKEN and the bottom as DATABASE_URL in your environment variables.
  7. Navigate to Better Auth and generate an auth secret. Set this as BETTER_AUTH_SECRET in your environment variables.
  8. (optional) Create an account on Sendgrid and set up a mailing address.
    • This is not necessary to get up and running, but is needed if you'd like working password reset and other email-related functionality.
  9. That's it! Head on over to Deployments in the top navigation bar, choose Create Deployment in the top right menu, and head on over to your project URL once it's done!

About

A snappy, customizable video feed. Designed to show you exactly the content you want to see and nothing else.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published

Contributors 2

  •  
  •  
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载