-
Using bash or other terminal
git clone https://github.com/tedxits2023/frontend.git
-
Using Github Desktop
It is encouraged to use yarn so the husky hooks can work properly.
yarn install
You can start the server using this command:
yarn dev
Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying src/app/page.tsx
.
This starter is using conventional commits, it is mandatory to use it to commit changes.
Frequently used commits :
-
fix : a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
Note : fix commits is only used when fixing bugs from the deployed version of code. If you made a mistake in your local while in development state and accidentally commited, amend it with
git commit --amend
-
feat : a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
Next.js + Tailwind CSS + TypeScript starter packed with useful development features.
Made by Theodorus Clarence
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
- 🃏 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, 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 👈 for more.
You can also check all of the details and demos on my blog post:
Are you using this starter? Please add your page (and repo) to the end of the list via a Pull Request. 😃
This starter is now equipped with an expansion pack.
You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.
CleanShot.2021-12-04.at.18.54.07-trimmed.mp4
Check out the expansion pack repository for the commands