Skip to content
/ catter Public

A minimal and responsive blog created with Next.js, MDX, TailwindCSS, and Shadcn's UI components.

Notifications You must be signed in to change notification settings

mkutay/catter

Repository files navigation

Catter

This is a minimal and responsive blog created with Next.js, MDX, TailwindCSS, and Shadcn's UI components. 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 LaTeX and syntax highlighting support,
  • has a page for projects you do,
  • has a system for tags for posts.

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.

Copy .env.example and populate .env.local. Use GitHub, Discord, and Spotify OAuth for guestbook and comments. Also, add the information from your Postgres database you use. In addition, you don't need to run any commands manually to set the database schema, as it is automatically done by Catter.

Change the values in 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.

Deploy with Vercel

Contributing

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

Catter example blog main page

About

A minimal and responsive blog created with Next.js, MDX, TailwindCSS, and Shadcn's UI components.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published