Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 3.07 KB

README.md

File metadata and controls

120 lines (81 loc) · 3.07 KB
Raw

Site

An personal site built with modern web technologies that uses @shadcn Taxonomy as a starter.

Warning This app is a work in progress. I'm building this in public. You can use it for your own site but breaking changes. You can follow the progress on LinkedIn @franciscomoretti.

Demo

Site Preview of docs page

About this project

This project uses Next.js app router and other new technologies. It's build with modern web development in mind.

The plan is to implement all the features and niceness for a personal blog.

Note on Performance

Warning This app is using the canary releases for Next.js 13 and React 18. The new router and app dir is still in beta and not production-ready. Expect some performance hits when testing the dashboard. If you see something broken, you can ping me @franmoretti_.

Features

  • ✅ New /app dir
  • ✅ Obsidian compatibility
  • ✅ TOC (Table of contents)
  • ✅ Documentation-like layout
  • ✅ Blog-like layout
  • ✅ Automatic Sitemap and RSS Feed
  • ✅ Loading UI
  • ✅ Server and Client Components
  • ✅ OG Image per post generated at the edge
  • ✅ UI Components built using Radix UI through Shadcn/ui
  • ✅ code-tips (documentation) and blog using MDX and Contentlayer
  • ✅ Styled using Tailwind CSS
  • ✅ Validations using Zod
  • ✅ Written in TypeScript
  • ✅ Copy code button
  • ✅ Search with cmdk
  • ✅ Custom tailwind styles
  • ✅ Show views for each post using Prisma and Turso
  • ✅ Personalized OG Images
  • ✅ Dark mode

Roadmap

  • Framer motion animations on home screen
  • Unit tests

Inspiration

Running Locally

  1. Install dependencies using pnpm:
pnpm install

Note: If you don't have pnpm, here is the installation guide.

  1. Copy .env.example to .env.local and update the variables.
cp .env.example .env.local
  1. Start the application:
pnpm dev

Customization

  1. Customize the site by using your own info in config/config.ts

  2. Put your content into the content directory and your assets in content/assets directory.

  3. Replace the opengraph-image.jpg for your own image and opengraph-image.alt.txt for its alt text.

Setting up Turso DB

Check out the setup guide

  1. Push the prisma DB
pnpm exec prisma db push

or

npx prisma db push

Analytics

Analytics are provided automatically by Vercel and their free tier is a great way to start. As an alternative, Posthog is integrated as well.

Posthog

To use Posthog you need to create an account and set the keys in the .env file

NEXT_PUBLIC_POSTHOG_KEY=<ph_project_api_key>
NEXT_PUBLIC_POSTHOG_HOST=<ph_instance_address>

License

Licensed under the MIT license.