Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doinel1a/next-ts-shadcn-ui
Boilerplate template designed to quickly bootstrap a Next.js Web App, SPA, website or landing page with TypeScript, Shadcn/ui, TailwindCSS, ESLint, Husky and much more in just 30 seconds.
https://github.com/doinel1a/next-ts-shadcn-ui
commitlint eslint husky lint-staged nextjs nextjs-boilerplate nextjs-template playwright prettier shadcn-ui tailwindcss typescript
Last synced: about 7 hours ago
JSON representation
Boilerplate template designed to quickly bootstrap a Next.js Web App, SPA, website or landing page with TypeScript, Shadcn/ui, TailwindCSS, ESLint, Husky and much more in just 30 seconds.
- Host: GitHub
- URL: https://github.com/doinel1a/next-ts-shadcn-ui
- Owner: doinel1a
- License: mit
- Created: 2024-01-03T17:08:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T15:16:00.000Z (3 months ago)
- Last Synced: 2024-08-12T17:43:15.025Z (3 months ago)
- Topics: commitlint, eslint, husky, lint-staged, nextjs, nextjs-boilerplate, nextjs-template, playwright, prettier, shadcn-ui, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://next-ts-shadcn-ui.d1a.app
- Size: 712 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[node]: https://nodejs.org/en
[pnpm]: https://pnpm.io/installation
[yarn]: https://yarnpkg.com/getting-started/install
[demo]: https://next-ts-shadcn-ui.d1a.app/
[license]: https://github.com/doinel1a/next-ts-shadcn-ui/blob/main/LICENSE
[code-of-conduct]: https://github.com/doinel1a/next-ts-shadcn-ui/blob/main/CODE_OF_CONDUCT.md
[issues]: https://github.com/doinel1a/next-ts-shadcn-ui/issues
[pulls]: https://github.com/doinel1a/next-ts-shadcn-ui/pulls
[browserslist]: https://browsersl.ist/#q=last+3+versions%2C%3E+0.2%25%2C+not+dead
[commitlint]: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
[chrome-icon]: https://github.com/alrra/browser-logos/blob/main/src/chrome/chrome_64x64.png
[firefox-icon]: https://github.com/alrra/browser-logos/blob/main/src/firefox/firefox_64x64.png
[edge-icon]: https://github.com/alrra/browser-logos/blob/main/src/edge/edge_64x64.png
[opera-icon]: https://github.com/alrra/browser-logos/blob/main/src/opera/opera_64x64.png
[safari-icon]: https://github.com/alrra/browser-logos/blob/main/src/safari/safari_64x64.png
# Next TypeScript & Shadcn/ui — Template
This development starter template is the ultimate solution to help you getting started on your project in no time, without the hassle of setting up and configuring your development environment from scratch each time you start working.
This repository is ideal for front-end developers who want to build modern, fast and reliable web applications with the latest cutting edge technologies such as **Next.js**, **TypeScript**, **Shadcn/ui**, **TailwindCSS**, **ESLint**, **Prettier**, **Husky** and much more!
---
**[Demo][demo]** **|** **[Bug(label: bug)][issues]** **|** **[Feature(label: enhancement)][issues]**
---
## :bookmark: Table of contents
- :computer: [Getting started](#computer-getting-started "Go to 'Getting started' section")
- :battery: [Features](#battery-features "Go to 'Features' section")
- :globe_with_meridians: [Browsers support](#globe_with_meridians-browsers-support "Go to 'Browsers support' section")
- :busts_in_silhouette: [Contribute](#busts_in_silhouette-contribute "Go to 'Contribute' section")
- :bookmark_tabs: [License](#bookmark_tabs-license "Go to 'License' section")
- :gem: [Acknowledgements](#gem-acknowledgements "Go to 'Acknowledgements' section")
---
## :computer: Getting started
### Prerequisites:
- JavaScript runtime **[node.js][node]**;
- **(OPTIONAL)** Alternative package manager:
- **[pnpm][pnpm]**
or
- **[yarn][yarn]**
### Start developing:
- Get the repository:
- click **"Use this template"** or **"Fork"** button
alternately
- **clone** the repository through your terminal:
```bash
git clone https://github.com/doinel1a/next-ts-shadcn-ui YOUR-PROJECT-NAME
```
- Open your terminal or code editor to the path your project is located, and run:
| | **npm** | **pnpm** | **yarn** |
| ------------------------------------------------ | ----------------- | -------------- | -------------- |
| To **install** the dependencies | `npm install` | `pnpm install` | `yarn install` |
| To **run** the **development server** | `npm run dev` | `pnpm dev` | `yarn dev` |
| To **build** your app **for production** | `npm run build` | `pnpm build` | `yarn build` |
| To **preview** your **production optimized app** | `npm run preview` | `pnpm preview` | `yarn preview` |
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")
---
## :battery: Features
This repository comes 🔋 packed with:
- **Next.js**;
- **TypeScript**;
- **Shadcn/ui**;
- **TailwindCSS**;
- **SASS** & **SCSS**;
- **ESLint**;
- **Prettier**;
- **Husky**;
- **Commitlint**;
- **Lint staged**;
- **Playwright**;
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")
---
## :globe_with_meridians: Browsers support
The provided configuration ensures **92.3%** coverage for all browsers, in particular of the following:
| Chrome | Firefox | Edge | Opera | Safari |
| :---------------------------: | :------------------------------: | :--------------------------: | :------------------: | ---------------------------- |
| ![Google Chrome][chrome-icon] | ![Mozilla Firefox][firefox-icon] | ![Microsoft Edge][edge-icon] | ![Opera][opera-icon] | ![Apple Safari][safari-icon] |
**\*** In order to support a wider percentage of browsers, update the `./.browserslistrc` configuration file:
1. `last 3 versions`: browser version;
2. `> 0.2%`: browser usage statistics;
3. `not dead`: whether the browser is officially supported;
Update the configuration [here][browserslist] and check in real-time the **global browsers support**.
**\* The more versions to support, larger JS and CSS bundles size will be.**
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")
---
## :busts_in_silhouette: Contribute
Contributions are what make the open source community such an amazing place to learn, inspire, and create.
Any contribution is greatly appreciated: big or small, it can be documentation updates, adding new features or something bigger.
Please check the [**contributing guide**][code-of-conduct] for details on how to help out and keep in mind that all commits must follow the **[conventional commit format][commitlint]**.
### How to contribute:
1. **[Get started](#computer-getting-started "Go to 'Getting started' section");**
2. **For a new feature:**
1. Create a new branch: `git checkout -b feat/NEW-FEATURE`;
2. Add your changes to the staging area: `git add PATH/TO/FILENAME.EXTENSION`;
3. Commit your changes: `git commit -m "feat: NEW FEATURE"`;
4. Push your new branch: `git push origin feat/NEW-FEATURE`;
3. **For a bug fix:**
1. Create a new branch: `git checkout -b fix/BUG-FIX`;
2. Add your changes to the staging area: `git add PATH/TO/FILENAME.EXTENSION`;
3. Commit your changes: `git commit -m "fix: BUG FIX"`;
4. Push your new branch: `git push origin fix/BUG-FIX`;
4. **Open a new [pull request][pulls];**
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")
---
## :bookmark_tabs: License
All logos and trademarks are the property of their respective owners.
Everything else is distributed under the **MIT License** .
See the [LICENSE][license] file for more informations.
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")
---
## :gem: Acknowledgements
Special thanks to:
- [alrra](https://github.com/alrra) for [browser-logos](https://github.com/alrra/browser-logos);
- [tandpfun](https://github.com/tandpfun) for [skill-icons](https://github.com/tandpfun/skill-icons);
[Back to :arrow_up:](#next-typescript--shadcnui--template "Back to 'Table of contents' section")