Skip to content

Latest commit

聽

History

History
85 lines (55 loc) 路 2.92 KB

README.md

File metadata and controls

85 lines (55 loc) 路 2.92 KB
Raw

Next Starter Peacock

馃 Next Starter Peacock

Peacock is a NextJS portfolio Starter for software engineers and designers. Showcase your awesome work and build personal sites you're proud of.

Features

  • Styled with Tailwind CSS
  • Written in TypeScript & Next 14 (RSC)
  • Blog, Notes and Work content types

Getting Started

  1. Fork the project. (It's highly recommended to fork the project to get upcoming features and bug fixes)

  2. Clone your fork

git clone https://github.com/<your-username>/next-starter-peacock.git
  1. Jump into the directory and Install dependencies
cd next-starter-peacock && yarn

or

cd next-starter-peacock && npm install
  1. Start the dev server
yarn dev

or

npm run dev
  1. Find config/index.json, change name and title to your name and title. Save and open http://localhost:3000 with your browser 馃挜馃挜馃挜. See the results 馃槉.

Customize Peacock

Peacock ships with 3 basic content types

  • Articles: Long form content. Think blog posts 馃摎. All articles are in the /content/articles folder. Any markdown document you add here will show on the /articles page.
  • Notes: Short form Spontaneous content 馃枊. All notes are in the /content/notes folder.
  • Works: Case studies and projects you want to show 馃洜. All works are in the /content/works folder. There's a selectedWork field in the markdown meta. Setting it to true will display the case study/work on the index.tsx page.

Deploy to Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Contributing

The best way you can contribute to peacock is by creating issues, reporting bugs and propose new features. If you're kind enough and have extra time, you can help on some features. Here's the simple workflow

  • Open issue to see if the feature is already worked on
  • Get go ahead to work on feature if it's not taken
  • Fork next-starter-peacock
  • Create your branch and do your magic
  • Send pull request
  • Pull request is merged

The fastest way to get an answer to your question is to reach out via Twitter. Feel free to through a tweet or DM.

Todo

  • Test rendering and styling of standard HTML elements
  • Replace personal portfolio content with demo content
  • Add simpler notes page
  • Image optimization (Fixed image heights to avoid layout janks)
  • RSS Feed
  • Release V1
  • Add page transitions with framer-motion
  • Add mdx support
  • Code syntax highlighting
  • og image generation with vercel/og