Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vickonrails/next-starter-peacock
🦚 Beautiful Nextjs starter for software engineers and designers to show work they're so proud of
https://github.com/vickonrails/next-starter-peacock
frontend javascript nextjs react
Last synced: 3 months ago
JSON representation
🦚 Beautiful Nextjs starter for software engineers and designers to show work they're so proud of
- Host: GitHub
- URL: https://github.com/vickonrails/next-starter-peacock
- Owner: vickonrails
- License: mit
- Created: 2020-08-22T13:05:08.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-09T20:00:41.000Z (8 months ago)
- Last Synced: 2024-08-01T00:38:42.451Z (3 months ago)
- Topics: frontend, javascript, nextjs, react
- Language: TypeScript
- Homepage: https://next-starter-peacock.vercel.app/
- Size: 24.1 MB
- Stars: 127
- Watchers: 6
- Forks: 44
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🦚 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
```bash
git clone https://github.com//next-starter-peacock.git
```
3. Jump into the directory and Install dependencies
```bash
cd next-starter-peacock && yarn
or
cd next-starter-peacock && npm install
```
4. Start the dev server
```bash
yarn dev
or
npm run dev
```
5. Find `config/index.json`, change `name` and `title` to your name and title. Save and open [http://localhost:3000](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](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## Contributing
The best way you can contribute to peacock is by [creating issues](https://github.com/vickOnRails/next-starter-peacock/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](https://twitter.com/vick_onrails). Feel free to through a tweet or DM.
## Todo
- [x] Test rendering and styling of standard HTML elements
- [x] Replace personal portfolio content with demo content
- [x] Add simpler notes page
- [x] Image optimization (Fixed image heights to avoid layout janks)
- [x] RSS Feed
- [ ] Release V1
- [x] Add page transitions with `framer-motion`
- [ ] Add mdx support
- [x] Code syntax highlighting
- [ ] og image generation with vercel/og