Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkutay/catter
A minimal and responsive blog created with Next.js, MDX, TailwindCSS, and Shadcn's UI components.
https://github.com/mkutay/catter
mdx nextjs shadcn-ui tailwindcss
Last synced: 10 days ago
JSON representation
A minimal and responsive blog created with Next.js, MDX, TailwindCSS, and Shadcn's UI components.
- Host: GitHub
- URL: https://github.com/mkutay/catter
- Owner: mkutay
- License: gpl-3.0
- Created: 2024-08-16T14:47:07.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-16T17:36:46.000Z (about 2 months ago)
- Last Synced: 2024-09-20T09:02:00.024Z (15 days ago)
- Topics: mdx, nextjs, shadcn-ui, tailwindcss
- Language: TypeScript
- Homepage: https://www.mkutay.dev
- Size: 7.25 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Catter
This is a minimal and responsive blog created with [Next.js](https://nextjs.org), [MDX](https://github.com/ipikuka/next-mdx-remote-client), [TailwindCSS](https://tailwindcss.com/), and [Shadcn's UI](https://ui.shadcn.com/) components. Catter
- is beautifully designed with colours from [Catppuccin](https://github.com/catppuccin/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](https://www.mkutay.dev) for a working example that is based on this repository.
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](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.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmkutay%2Fcatter)
## Contributing
Any and all contributions are welcome as a pull request. You can also open an issue if you have any questions or problems.
