https://github.com/mr-meshky/nextjs-example

A ready next js template with custom husky and eslint
https://github.com/mr-meshky/nextjs-example

eslint example husky nextjs typescript

Last synced: about 1 month ago
JSON representation

A ready next js template with custom husky and eslint

• Host: GitHub
• URL: https://github.com/mr-meshky/nextjs-example
• Owner: Mr-Meshky
• Created: 2024-10-15T14:12:54.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:04:35.000Z (3 months ago)
• Last Synced: 2024-12-18T04:09:11.018Z (about 1 month ago)
• Topics: eslint, example, husky, nextjs, typescript
• Language: TypeScript
• Homepage:
• Size: 193 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Next.js Example Template

This repository provides a ready-made template for Next.js projects to help you quickly get started with a modern web application. It includes a basic project setup with the latest Next.js features and best practices.

## Features

- **Next.js**: The latest version of Next.js to power your project.

- **Pre-configured ESLint**: Ensures code quality with pre-configured ESLint rules.

- **Pre-commit & Pre-push**: Automatically run lint checks and build processes before committing or pushing changes.

- **Tailwind and Import Sorter**: Automatic sorting for Tailwind CSS classes and JavaScript/TypeScript imports.

  

## Getting Started

To create a new project based on this template, run the following command:

```bash

npx create-next-app my-nextjs-app -e https://github.com/Mr-Meshky/nextjs-example/

```

This will create a new directory `my-nextjs-app` with all the files from this template.

### Running the Project

Once you've created the project, navigate into the project directory:

```bash

cd my-nextjs-app

```

Install the necessary dependencies:

```bash

npm install

# or

yarn install

```

Start the development server:

```bash

npm run dev

# or

yarn dev

```

Now open [http://localhost:3000](http://localhost:3000) to view the project in your browser.

## Customization

Feel free to modify the template to suit your needs. You can edit any component, create new pages, or add additional libraries as needed.