Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natterstefan/nextjs-template
A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀
https://github.com/natterstefan/nextjs-template
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
Last synced: about 1 month ago
JSON representation
A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀
- Host: GitHub
- URL: https://github.com/natterstefan/nextjs-template
- Owner: natterstefan
- License: mit
- Created: 2020-12-04T18:47:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T02:23:56.000Z (over 1 year ago)
- Last Synced: 2024-05-02T02:05:08.406Z (2 months ago)
- 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
- Language: TypeScript
- Homepage: https://nextjs-template-app.vercel.app
- Size: 1.98 MB
- Stars: 32
- Watchers: 2
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome - natterstefan/nextjs-template - A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀 (TypeScript)
- awesome-stars - natterstefan/nextjs-template - A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀 (TypeScript)
README
# nextjs-template
[](https://github.com/natterstefan/nextjs-template/actions/workflows/ci.yml)
[](https://github.com/natterstefan/nextjs-template/issues)
[](https://github.com/natterstefan/nextjs-template/stargazers)
[](https://github.com/natterstefan/nextjs-template/blob/main/LICENSE)
[](https://github.com/natterstefan/nextjs-template)
Ready to go template repository for your next Next.js application! 🚀
## Features
- ⭐️ [[email protected]](https://nextjs.org/)
- ⭐️ [[email protected]](https://tailwindcss.com)
- ⭐️ [Jest](https://jestjs.io/)
- ⭐️ [Storybook](https://storybook.js.org/)
- ⭐️ [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)
- ⭐️ [Docker](https://www.docker.com/)
- ⭐️ [i18n](https://www.i18next.com/)
- ⭐️ [Cypress](https://www.cypress.io/)
- ⭐️ One-Click deployment to [Vercel](https://vercel.co/)
## Requirements
Following tools are required:
- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- [Docker](https://docker.com)
- [Java](https://openjdk.java.net/)
- Optimized for [Visual Studio Code](https://code.visualstudio.com/)
For easy version management of the requirements above, we recommend using
[asdf](https://asdf-vm.com/). It will automatically use the nailed versions (see
[tools-version](.tool-versions)). For Docker and Java we recommend the latest
available versions.
## Installation & Setup
```bash
yarn
```
Once the task is completed you can start the app with `yarn dev`.
## Start
```bash
# development mode
yarn dev
# production mode
yarn build
yarn start
```
### Probe Status `/api/probe-status`
The server comes with a Probe Status HTTP endpoint to test if app is running.
### Version `/api/version`
The server comes with a Version HTTP endpoint to see which version is running.
## Development
### Tests & Code Style
```bash
yarn test
yarn lint
```
## Deployment
### Deploy your own
Deploy `nextjs-template` using [Vercel](https://vercel.com):
[](https://vercel.com/import/project?template=https://github.com/natterstefan/nextjs-template)
### Docker
`nextjs-template` also provides a Docker Image (see [docker](./docker)) and
docker-compose setup.
#### Build Docker Image
```bash
./gradlew buildDockerImage
```
#### Run Docker Image
```bash
./gradlew runDockerBuild
```
Or when you want to run it in the background:
```bash
docker-compose --env-file ./.env.local up -d
```
## References
- based on
## License
[MIT](./LICENSE)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
---
_Based on the template._
