{"id":13455824,"url":"https://github.com/natterstefan/nextjs-template","last_synced_at":"2025-04-11T21:53:08.260Z","repository":{"id":39517811,"uuid":"318607582","full_name":"natterstefan/nextjs-template","owner":"natterstefan","description":"A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀","archived":false,"fork":false,"pushed_at":"2023-01-01T02:23:56.000Z","size":2075,"stargazers_count":32,"open_issues_count":23,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T21:53:00.724Z","etag":null,"topics":["cypress","cypress-example","cypress-io","docker-image","eslint","nextjs","nextjs-boilerplate","nextjs-starter","nextjs-template","nextjs-typescript","prettier","react","reactjs","storybook","storybooks","tailwindcss","typescript","typescript-eslint","typescript-react","vercel"],"latest_commit_sha":null,"homepage":"https://nextjs-template-app.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/natterstefan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["natterstefan"],"patreon":"natterstefan","custom":["https://www.paypal.me/natterstefan","https://www.buymeacoffee.com/natterstefan"]}},"created_at":"2020-12-04T18:47:54.000Z","updated_at":"2024-02-06T20:27:43.000Z","dependencies_parsed_at":"2023-01-31T20:31:45.766Z","dependency_job_id":null,"html_url":"https://github.com/natterstefan/nextjs-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fnextjs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fnextjs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fnextjs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fnextjs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natterstefan","download_url":"https://codeload.github.com/natterstefan/nextjs-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487733,"owners_count":21112188,"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":["cypress","cypress-example","cypress-io","docker-image","eslint","nextjs","nextjs-boilerplate","nextjs-starter","nextjs-template","nextjs-typescript","prettier","react","reactjs","storybook","storybooks","tailwindcss","typescript","typescript-eslint","typescript-react","vercel"],"created_at":"2024-07-31T08:01:11.748Z","updated_at":"2025-04-11T21:53:08.231Z","avatar_url":"https://github.com/natterstefan.png","language":"TypeScript","funding_links":["https://github.com/sponsors/natterstefan","https://patreon.com/natterstefan","https://www.paypal.me/natterstefan","https://www.buymeacoffee.com/natterstefan"],"categories":["TypeScript"],"sub_categories":[],"readme":"# nextjs-template\n\n[![Node CI](https://github.com/natterstefan/nextjs-template/actions/workflows/ci.yml/badge.svg)](https://github.com/natterstefan/nextjs-template/actions/workflows/ci.yml)\n[![GitHub issues](https://img.shields.io/github/issues/natterstefan/nextjs-template)](https://github.com/natterstefan/nextjs-template/issues)\n[![GitHub stars](https://img.shields.io/github/stars/natterstefan/nextjs-template)](https://github.com/natterstefan/nextjs-template/stargazers)\n[![GitHub license](https://img.shields.io/github/license/natterstefan/nextjs-template)](https://github.com/natterstefan/nextjs-template/blob/main/LICENSE)\n[![nextjs](https://img.shields.io/badge/nextjs-built%20with%20typescript-informational.svg?logo=typescript\u0026logoWidth=20)](https://github.com/natterstefan/nextjs-template)\n\n![natterstefan/nextjs-template](./assets/github.png)\n\nReady to go template repository for your next Next.js application! 🚀\n\n## Features\n\n- ⭐️ [Next.js@10.x](https://nextjs.org/)\n- ⭐️ [Tailwind@2.x](https://tailwindcss.com)\n- ⭐️ [Jest](https://jestjs.io/)\n- ⭐️ [Storybook](https://storybook.js.org/)\n- ⭐️ [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)\n- ⭐️ [Docker](https://www.docker.com/)\n- ⭐️ [i18n](https://www.i18next.com/)\n- ⭐️ [Cypress](https://www.cypress.io/)\n- ⭐️ One-Click deployment to [Vercel](https://vercel.co/)\n\n## Requirements\n\nFollowing tools are required:\n\n- [Node.js](https://nodejs.org/)\n- [Yarn](https://yarnpkg.com/)\n- [Docker](https://docker.com)\n- [Java](https://openjdk.java.net/)\n- Optimized for [Visual Studio Code](https://code.visualstudio.com/)\n\nFor easy version management of the requirements above, we recommend using\n[asdf](https://asdf-vm.com/). It will automatically use the nailed versions (see\n[tools-version](.tool-versions)). For Docker and Java we recommend the latest\navailable versions.\n\n## Installation \u0026 Setup\n\n```bash\nyarn\n```\n\nOnce the task is completed you can start the app with `yarn dev`.\n\n## Start\n\n```bash\n# development mode\nyarn dev\n\n# production mode\nyarn build\nyarn start\n```\n\n### Probe Status `/api/probe-status`\n\nThe server comes with a Probe Status HTTP endpoint to test if app is running.\n\n### Version `/api/version`\n\nThe server comes with a Version HTTP endpoint to see which version is running.\n\n## Development\n\n### Tests \u0026 Code Style\n\n```bash\nyarn test\nyarn lint\n```\n\n## Deployment\n\n### Deploy your own\n\nDeploy `nextjs-template` using [Vercel](https://vercel.com):\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/natterstefan/nextjs-template)\n\n### Docker\n\n`nextjs-template` also provides a Docker Image (see [docker](./docker)) and\ndocker-compose setup.\n\n#### Build Docker Image\n\n```bash\n./gradlew buildDockerImage\n```\n\n#### Run Docker Image\n\n```bash\n./gradlew runDockerBuild\n```\n\nOr when you want to run it in the background:\n\n```bash\ndocker-compose --env-file ./.env.local up -d\n```\n\n## References\n\n- based on \u003chttps://github.com/vercel/next.js/tree/master/examples/with-tailwindcss\u003e\n\n## License\n\n[MIT](./LICENSE)\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://natterstefan.me/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1043668?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eStefan Natter\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#ideas-natterstefan\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n---\n\n_Based on the \u003chttps://github.com/natterstefan/nextjs-template\u003e template._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatterstefan%2Fnextjs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatterstefan%2Fnextjs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatterstefan%2Fnextjs-template/lists"}