Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angeloanan/personal-next-template
▲ | My personal starter for NextJS: TS, Tailwind, HeadlessUI, ESLint, Prettier, Git Hooks
https://github.com/angeloanan/personal-next-template
headlessui nextjs react tailwind template typescript
Last synced: 3 months ago
JSON representation
▲ | My personal starter for NextJS: TS, Tailwind, HeadlessUI, ESLint, Prettier, Git Hooks
- Host: GitHub
- URL: https://github.com/angeloanan/personal-next-template
- Owner: angeloanan
- License: mit
- Created: 2021-12-03T09:30:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T18:50:02.000Z (5 months ago)
- Last Synced: 2024-10-24T21:36:34.624Z (3 months ago)
- Topics: headlessui, nextjs, react, tailwind, template, typescript
- Language: JavaScript
- Homepage:
- Size: 1.82 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# personal-next-template
🍪 | My personal starter for NextJS: TS, Tailwind, HeadlessUI, ESLint, Prettier, Git Hooks
## Features
- Next 14 with page routes
- React 18
- TypeScript
- Tailwind CSS 3
- Headless UI
- Built-in code quality tools
- Linting & Code Formatting
- ESLint
- Prettier
- GitHub Actions
- Auto-lint on push
- Auto link issue with PR
- Deployment
- Optimized Dockerfile
- Pre-production checklist
## Getting Started
### 1. Clone the repository
You can use any of the following way:
- Using the 'Use this repo as template' button
- Using `degit`:
```bash
pnpx degit angeloanan/personal-next-template YOUR_APP_NAME
```
### 2. Install dependencies
```bash
pnpm i
```
### 3. Run the development server
```bash
pnpm dev
```
Open [localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying [`src/pages/index.tsx`](./src/pages/index.tsx).
## Pre-production Checklist
- [ ] Whitelabel package.json with your project information (enable `private: true` if needed)
- [ ] Lock dependencies version to major
- [ ] Replace SEO configurations at [next-seo.config.js](./next-seo.config.js) and [next-sitemap.config.js](./next-sitemap.config.js)
- [ ] Setup CI/CD that'll automatically deploy the app on update