A snappy, customizable video feed. Designed to show you exactly the content you want to see and nothing else.
All release notes can be found at https://serial.tube/releases.
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:
- Clone the repository locally
- Duplicate the
.env.example
file, and rename the copy to.env
- Create a new database on Turso
- Sign up for an account if you don't have one, and navigate to the database dashboard
- Create a new database
- In the top right dropdown menu, click "Create Token"
- Create a token with read and write permissions
- On the success screen, save the top value as
DATABASE_AUTH_TOKEN
and the bottom asDATABASE_URL
- Navigate to Better Auth and generate an auth secret. Set this as
BETTER_AUTH_SECRET
- (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.
- Install your packages with
pnpm
- If you don't have it already, install pnpm
- Run
pnpm i
to install packages
- That's it! Run
pnpm dev
to migrate your database for the first time and boot up the development server.
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:
- Fork the
hfellerhoff/serial
respository to your own GitHub account. - Login to Vercel and follow the onboarding to link your GitHub account.
- Choose the
serial
repository and hit deploy. Your initial deployment will fail – that's okay. - Within your project, navigate to
Settings > Domains
. You have a few options for project domains:- You can copy the provided domain as is
- You can update the provided domain with a new name
- You can link an existing domain
- Whichever domain you choose, copy that name and head down to
Environment Variables
. Add that domain value asNEXT_PUBLIC_ROOT_URL
, being sure to include the protocol (https://
) - Create a new database on Turso
- Sign up for an account if you don't have one, and navigate to the database dashboard
- Create a new database
- In the top right dropdown menu, click "Create Token"
- Create a token with read and write permissions
- On the success screen, save the top value as
DATABASE_AUTH_TOKEN
and the bottom asDATABASE_URL
in your environment variables.
- Navigate to Better Auth and generate an auth secret. Set this as
BETTER_AUTH_SECRET
in your environment variables. - (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.
- That's it! Head on over to
Deployments
in the top navigation bar, chooseCreate Deployment
in the top right menu, and head on over to your project URL once it's done!