Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karniv00l/next-tailwind-template
My personal Next.js + TS + Tailwind template
https://github.com/karniv00l/next-tailwind-template
Last synced: 2 days ago
JSON representation
My personal Next.js + TS + Tailwind template
- Host: GitHub
- URL: https://github.com/karniv00l/next-tailwind-template
- Owner: karniv00l
- License: mit
- Created: 2023-10-24T18:29:50.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-03-07T18:28:22.000Z (7 months ago)
- Last Synced: 2024-05-01T16:09:16.195Z (5 months ago)
- Language: TypeScript
- Homepage: https://karniv00l.github.io/next-tailwind-template
- Size: 180 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js + TS + Tailwind template
My personal Next.js + TS + Tailwind template
## Tech stack
- [Next.js](https://nextjs.org)
- [Tailwind CSS](https://tailwindcss.com)
- [TypeScript](https://www.typescriptlang.org)
- [ESLint](https://eslint.org)
- [Prettier](https://prettier.io)
## Development
Node.js (see version in: [.nvmrc](./.nvmrc)) is required.
```bash
# install dependencies
npm ci
# start development server
npm start
# lint code
npm run lint
# fix lint errors
npm run lint:fix
```
Open [http://localhost:36969](http://localhost:36969) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Setting up VSCode
List of recommended extensions is stored in [.vscode/extensions.json](./.vscode/extensions.json).
VSCode will prompt you to install them when you open the project for the first time.
Settings are stored in [.vscode/settings.json](./.vscode/settings.json). This will enable automatic formatting on save and automatic linting.
## GitHub Actions
This project has code linting workflow set up: [.github/workflows/lint.yml](./.github/workflows/lint.yml).
## Building
```bash
npm run build
```
After building, the `build` directory contains all static files that can be served by any static hosting. To test the production build run:
```bash
npm run serve
```