Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avneesh0612/next-starter
This template has everything you need to start building your Next.js app with typescript, tailwind CSS, and ESlint 🎉
https://github.com/avneesh0612/next-starter
eslint linter next nextjs tailwind tailwindcss template typescript vercel
Last synced: 7 days ago
JSON representation
This template has everything you need to start building your Next.js app with typescript, tailwind CSS, and ESlint 🎉
- Host: GitHub
- URL: https://github.com/avneesh0612/next-starter
- Owner: avneesh0612
- License: gpl-3.0
- Created: 2021-09-21T03:40:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T02:58:08.000Z (almost 3 years ago)
- Last Synced: 2023-03-10T05:32:33.406Z (over 1 year ago)
- Topics: eslint, linter, next, nextjs, tailwind, tailwindcss, template, typescript, vercel
- Language: TypeScript
- Homepage: https://next-starter-avneesh.vercel.app
- Size: 5.78 MB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Next.js + TypeScript + TailwindCSS and ESLint Starter Template
This is a simple and minimalistic Next.js, TypeScript, TailwindCSS and ESLint template with all the starter files and dependencies already setup and ready for you to use.
**List of modules and libraries pre-installed in this template**:
- next
- tailwindcss
- postcss
- autoprefixer
- typescript
- eslint
- next-pwa
**next**: The core library required for the functioning of Next.js.
**tailwindcss**: The main library required for TailwindCSS along with **postcss** and **autoprefixer**.
**typescript**: Library which enables us to use TypeScript.
**eslint**: Library useful for setting up ESLint in our project.
**next-pwa**: A Library used for making working PWA's(Progressive Web App's) easily in Next.js.
# How and when to use this template
There are many developers who would like to have a stable workflow comprising of Next.js, TypeScript, TailwindCSS and ESLint which makes their coding a lot easier. This template is tailor-made for those developers. Installing all of these libraries on its own is a pain and time consuming. With this template, with a few steps that take a lot less time you are able to setup your workflow.
Now, how to use this template. This template is publicly available for you to use [here](https://github.com/avneesh0612/next-starter). You can click on **Use this template** which allows you to create a duplicate repository with the same files but in your GitHub account.
Proceeding further, you need to clone the repo locally to use it in your projects. You can do this via **git** or using the **zip file**.
Now you have succesfully incorporated the starter template into your workflow! 🥳
# Contributing Guide
In case of any contributions to this template, please make sure that your pull requests follow these basic rules:
- Please ensure that your pr's(Pull Requests) are relatable and applicable to the base intention of this template.
- Pr's can be in the form of any optimizations / better practices within the template.
- Please refrain from adding unnecessary features and over-engineering the template. Keep it simple.
- Making changes that are not applicable to the template will not be accepted.
- Improving the documentation will also be appreciated
Hoping for optimal cooperation from contributors.
Before using this template, we suggest you to have a quick look at the [CODE_OF_CONDUCT.md](https://github.com/avneesh0612/next-starter/blob/main/CODE_OF_CONDUCT.md) and [CHANGELOG.md](https://github.com/avneesh0612/next-starter/blob/main/CHANGELOG.md)
# License
[GNU General Public License](https://github.com/avneesh0612/next-starter/blob/main/LICENSE) © 2021 [Avneesh Agarwal](https://github.com/avneesh0612)