Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naufalbasara/gadai-web
https://github.com/naufalbasara/gadai-web
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/naufalbasara/gadai-web
- Owner: naufalbasara
- Created: 2024-07-30T17:10:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-05T08:19:21.000Z (5 months ago)
- Last Synced: 2024-08-05T14:17:19.736Z (5 months ago)
- Language: TypeScript
- Size: 269 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Next.js + Tailwind CSS + TypeScript Starter and Boilerplate
🔋 ts-nextjs-tailwind-starter
Next.js + Tailwind CSS + TypeScript starter packed with useful development features.
Made by Theodorus Clarence
[](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/stargazers)
[](https://depfu.com/github/theodorusclarence/ts-nextjs-tailwind-starter?project_id=30160)
[](https://shields.io/)
## Features
This repository is 🔋 battery packed with:
- ⚡️ Next.js 13
- ⚛️ React 18
- ✨ TypeScript
- 💨 Tailwind CSS 3 — Configured with CSS Variables to extend the **primary** color
- 💎 Pre-built Components — Components that will **automatically adapt** with your brand color, [check here for the demo](https://tsnext-tw.thcl.dev/components)
- 🃏 Jest — Configured for unit testing
- 📈 Absolute Import and Path Alias — Import components using `@/` prefix
- 📏 ESLint — Find and fix problems in your code, also will **auto sort** your imports
- 💖 Prettier — Format your code consistently
- 🐶 Husky & Lint Staged — Run scripts on your staged files before they are committed
- 🤖 Conventional Commit Lint — Make sure you & your teammates follow conventional commit
- ⏰ Release Please — Generate your changelog by activating the `release-please` workflow
- 👷 Github Actions — Lint your code on PR
- 🚘 Automatic Branch and Issue Autolink — Branch will be automatically created on issue **assign**, and auto linked on PR
- 🔥 Snippets — A collection of useful snippets
- 👀 Default Open Graph — Awesome open graph generated using [og](https://github.com/theodorusclarence/og), fork it and deploy!
- 🗺 Site Map — Automatically generate sitemap.xml
- 📦 Expansion Pack — Easily install common libraries, additional components, and configs
See the 👉 [feature details and changelog](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/blob/main/CHANGELOG.md) 👈 for more.
You can also check all of the **details and demos** on my blog post:
- [One-stop Starter to Maximize Efficiency on Next.js & Tailwind CSS Projects](https://theodorusclarence.com/blog/one-stop-starter)
## Getting Started
### 1. Clone this template using one of the three ways:
1. Use this repository as template
**Disclosure:** by using this repository as a template, there will be an attribution on your repository.
I'll appreciate if you do, so this template can be known by others too 😄
2. Using `create-next-app`
```bash
npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter project-name
```
3. Using `degit`
```bash
npx degit theodorusclarence/ts-nextjs-tailwind-starter YOUR_APP_NAME
```
4. Deploy to Vercel
[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Ftheodorusclarence%2Fts-nextjs-tailwind-starter)
### 2. Install dependencies
It is encouraged to use **yarn** so the husky hooks can work properly.
```bash
yarn install
```
### 3. Run the development server
You can start the server using this command:
```bash
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying `src/pages/index.tsx`.
### 4. Change defaults
There are some things you need to change including title, urls, favicons, etc.
Find all comments with !STARTERCONF, then follow the guide.
Don't forget to change the package name in package.json
### 5. Commit Message Convention
This starter is using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
## Projects using ts-nextjs-tailwind-starter
- [theodorusclarence.com](https://theodorusclarence.com) ([Source](https://github.com/theodorusclarence/theodorusclarence.com))
- [Notiolink](https://notiolink.thcl.dev/) ([Source](https://github.com/theodorusclarence/notiolink))
Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/edit/main/README.md). 😃
## Expansion Pack 📦
This starter is now equipped with an [expansion pack](https://github.com/theodorusclarence/expansion-pack).
You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.
https://user-images.githubusercontent.com/55318172/146631994-e1cac137-1664-4cfe-950b-a96decc1eaa6.mp4
Check out the [expansion pack repository](https://github.com/theodorusclarence/expansion-pack) for the commands