Catter

This is a minimal and responsive blog created with Next.js, MDX, TailwindCSS, Shadcn's UI components, and Drizzle ORM. Catter

• is beautifully designed with colours from Catppuccin,
• has support for Markdown and MDX,
• has a custom designed comment system,
• has view counter for every post,
• has a page where anyone on the internet can sign and mark their presence,
• has shortened URL support for every post,
• has an RSS feed,
• supports MinIO/S3 for image hosting,
• has LaTeX support in markdown,
• has a page for projects you do,
• has a system for tags for posts,
• uses CodeHike for beautifully designed code blocks.

See my blog for a working example that is based on this repository.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Create an environment file .env (or for each stage, i.e., .env.development, .env.production, and .env.test) with the following fields:

# Any authentication method can be removed or added.
SPOTIFY_OAUTH_CLIENT_SECRET=
SPOTIFY_OAUTH_CLIENT_ID=
DISCORD_OAUTH_CLIENT_SECRET=
DISCORD_OAUTH_CLIENT_ID=
GITHUB_OAUTH_CLIENT_ID=
GITHUB_OAUTH_CLIENT_SECRET=

# For NextAuth to work, see: https://authjs.dev/getting-started/installation?framework=next-js
AUTH_SECRET=
AUTH_REDIRECT_PROXY_URL=YOUR_SITE/api/auth

POSTGRES_URL= # The URL of the postgres database, hosted somewhere.

NODE_ENV=development

MINIO_ENDPOINT=
MINIO_ACCESS_KEY=
MINIO_SECRET_KEY=
MINIO_REGION=eu-central
S3_BUCKET_NAME=

SITE_URL="http://localhost:3000"

# For you to upload/delete new posts.
UPLOAD_API_KEY=

# Set to "true" during the build process.
BUILDING=

After setting up your database, run the migrations:

bun run db:migrate

Change the values in src/config/site.ts to change the config of your site. Importantly, add your email to admins to access the admin page on your site, where you can delete comments and guestbook entries.

Deploying

You can fork this repository and add it to Vercel manually, or you can use the following button.

Or, you can use the given Dockerfile:

docker build -t catter .
docker run -p 3000:3000 -e  catter

Contributing

Any and all contributions are welcome as a pull request. You can also open an issue if you have any questions or problems.