Skip to content

Latest commit

 

History

History
65 lines (58 loc) · 2.17 KB

README.md

File metadata and controls

65 lines (58 loc) · 2.17 KB
Raw

My website

🔧 Stack

📁 Project Structure

$PROJECT_ROOT
├── content/
├── messages/
├── prisma/
├── public/
└── src/
    ├── app/
    ├── components/
    ├── providers/
    ├── config/
    ├── hooks/
    ├── lib/
    ├── styles/
    ├── types/
    ├── utils/
    ├── i18n.ts
    └── middleware.ts
  • content/*: MDX blog posts, projects and the content for the about page.
  • messages/*: Data for multi-language support
  • prisma/*: Database Model Definition
  • public/*: Static resource, like image
  • src/app/*: Every page and api route in the website. Uses the App Router from Next.js 14
  • src/components/*: All components I use in the website. Note that the components in the ui folder will be smaller components, such as link, button, dropdown etc.
  • src/providers/*: All providers I use in the website
  • src/config/*: Some basic settings or static data
  • src/hooks/*: Some custom hooks for website
  • src/lib/*: a collection of helpful utilities or code for third-party services
  • src/styles/*: Global Styles with Tailwindcss
  • src/types/*: Some Global Types definitions
  • src/utils/*: Some utilities functions , but less complex than lib/

👋 Getting Start

git clone https://github.com/tommm2/jinrup.dev.git

cd jinrup.dev
nvm use
pnpm install
pnpm run dev
  • Create .env file similar to .env.example.
  • Change config/site.ts, config/giscus.ts, app/sitemap.ts to you own and Remove content/*.

📜 License

This work is licensed by JHENG RONG JIN.

  • You are free to use this code as inspiration.
  • Please do not copy it directly.
  • Crediting the author is appreciated.