Skip to content

Latest commit

 

History

History
111 lines (70 loc) · 3.73 KB

README.md

File metadata and controls

111 lines (70 loc) · 3.73 KB

Next.js Application with TypeScript, Tailwind CSS, Material-UI, Base Web, Husky, lint-staged, and Prettier

This is a boilerplate README file for a Next.js application using TypeScript as the primary language. The project includes additional libraries such as Tailwind CSS, Material-UI (BaseUI), Husky, lint-staged, and Prettier for enhanced development experience and code quality.

Prerequisites

Make sure you have the following dependencies installed on your system:

  • Node.js (v18.15.0 or higher)
  • pnpm (v6 or higher, recommended for this project)

Getting Started

To get started with the project, follow these steps:

  1. Clone the repository:

    git clone <repository-url>

  2. Change into the project directory:

    cd <project-directory>

  3. Install project dependencies using pnpm:

    pnpm install

Development

To start the development server, run the following command:

pnpm dev

This will start the Next.js development server, and your application will be available at http://localhost:3000.

Building for Production

To build the application for production, run the following command:

pnpm build

This command will create an optimized production build of your Next.js application.

Additional Features

The project includes the following additional libraries:

  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • Material-UI: A popular React UI framework with a wide range of components and themes.
  • Husky: A Git hook manager for running scripts before committing or pushing code.
  • lint-staged: A tool for running linters on staged files, used in combination with Husky.
  • Prettier: A code formatter that ensures consistent code style throughout the project.
  • NextAuth.js: An authentication library for Next.js applications, providing a simple and flexible authentication solution.

Code Quality and Formatting

The project utilizes ESLint for linting and Prettier for code formatting. You can run the following command to lint your code:

pnpm lint

To automatically fix linting errors, you can run:

pnpm lint:fix

The project also includes a pre-commit hook that runs linting and formatting checks before each commit, ensuring that only clean and formatted code is committed.

Customize Configuration

You can customize the configuration for ESLint, Prettier, and other tools by modifying the respective configuration files:

  • .eslintrc.js: ESLint configuration file.
  • .prettierrc.js: Prettier configuration file.

Contributing

Contributions are welcome! If you find any issues or want to enhance the project, feel free to open a pull request. Please follow the existing coding style and commit message conventions.

License

This project is licensed under the MIT License.

Acknowledgments

This project is based on best practices and popular libraries in the Next.js ecosystem. Special thanks to the authors and contributors of the following projects:

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainer at [email protected].