{"id":14007219,"url":"https://github.com/vickonrails/next-starter-peacock","last_synced_at":"2025-07-24T01:31:07.847Z","repository":{"id":40541406,"uuid":"289489096","full_name":"vickonrails/next-starter-peacock","owner":"vickonrails","description":"🦚 Beautiful Nextjs starter for software engineers and designers to show work they're so proud of ","archived":false,"fork":false,"pushed_at":"2024-03-09T20:00:41.000Z","size":25245,"stargazers_count":129,"open_issues_count":2,"forks_count":44,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-26T23:12:32.799Z","etag":null,"topics":["frontend","javascript","nextjs","react"],"latest_commit_sha":null,"homepage":"https://next-starter-peacock.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vickonrails.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-08-22T13:05:08.000Z","updated_at":"2024-08-07T00:21:07.000Z","dependencies_parsed_at":"2023-11-29T10:29:30.882Z","dependency_job_id":"ff6fcc98-593c-4486-a9a9-ad8c604c1a7f","html_url":"https://github.com/vickonrails/next-starter-peacock","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vickonrails%2Fnext-starter-peacock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vickonrails%2Fnext-starter-peacock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vickonrails%2Fnext-starter-peacock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vickonrails%2Fnext-starter-peacock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vickonrails","download_url":"https://codeload.github.com/vickonrails/next-starter-peacock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227384188,"owners_count":17772330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["frontend","javascript","nextjs","react"],"created_at":"2024-08-10T10:01:55.176Z","updated_at":"2024-11-30T17:32:21.536Z","avatar_url":"https://github.com/vickonrails.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"![Next Starter Peacock](./.github/screenshot.png)\n\n# 🦚 Next Starter Peacock\n\nPeacock is a NextJS portfolio Starter for software engineers and designers. Showcase your awesome work and build personal sites you're proud of.\n\n## Features\n\n- Styled with Tailwind CSS\n- Written in TypeScript \u0026 Next 14 (RSC)\n- Blog, Notes and Work content types \n\n## Getting Started\n\n1. Fork the project. (It's highly recommended to fork the project to get upcoming features and bug fixes)\n\n2. Clone your fork\n\n```bash\ngit clone https://github.com/\u003cyour-username\u003e/next-starter-peacock.git\n```\n\n3. Jump into the directory and Install dependencies\n\n```bash\ncd next-starter-peacock \u0026\u0026 yarn\n\nor\n\ncd next-starter-peacock \u0026\u0026 npm install\n```\n\n4. Start the dev server\n\n```bash\nyarn dev\n\nor\n\nnpm run dev\n```\n\n5. 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 😊.\n\n---\n\n## Customize Peacock\n\nPeacock ships with 3 basic content types\n\n- **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.\n- **Notes**: Short form Spontaneous content 🖋. All notes are in the `/content/notes` folder.\n- **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.\n\n## Deploy to Vercel\n\nThe easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme) from the creators of Next.js.\n\nCheck out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n\n## Contributing\n\nThe 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\n\n- Open issue to see if the feature is already worked on\n- Get go ahead to work on feature if it's not taken\n- Fork `next-starter-peacock`\n- Create your branch and do your magic\n- Send pull request\n- Pull request is merged\n\nThe 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.\n\n## Todo\n\n- [x] Test rendering and styling of standard HTML elements\n- [x] Replace personal portfolio content with demo content\n- [x] Add simpler notes page\n- [x] Image optimization (Fixed image heights to avoid layout janks)\n- [x] RSS Feed\n- [ ] Release V1\n- [x] Add page transitions with `framer-motion`\n- [ ] Add mdx support\n- [x] Code syntax highlighting\n- [ ] og image generation with vercel/og\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvickonrails%2Fnext-starter-peacock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvickonrails%2Fnext-starter-peacock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvickonrails%2Fnext-starter-peacock/lists"}