This repository is a boilerplate to kickstart your Next.js projects with best practices and tools for modern web development. It includes various configurations and integrations to make development easier and more efficient.
- Next.js: A React framework for production that includes server-side rendering, static site generation, and more. Next.js Website
- Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces. Tailwind CSS Website
- Prettier: An opinionated code formatter to ensure code consistency. Prettier Website
- ESLint: A static code analysis tool for identifying problematic patterns in JavaScript/TypeScript code. ESLint Website
- Husky: Git hooks to ensure linting and formatting before committing. Husky Website
- GitHub Workflows (CI): Automated Continuous Integration (CI) setup using GitHub Actions.
- .npmrc & .nvmrc: Config files to manage Node.js versions and package manager settings.
- VSCode Settings: Editor settings specific to the project to ensure a consistent development environment.
- EditorConfig: Standardizes coding styles between different editors and IDEs. EditorConfig Website
Make sure you have the following tools installed:
- Node.js (use the correct version specified in
.nvmrc
) - Yarn as your package manager
- Git for version control
- Clone the repository:
https://github.com/vishnu-mouli-102408/next-js-starter-template.git
- Install Dependencies:
yarn install
- Running the Project:
yarn dev
This will start the Next.js development server, and the app will be available at
http://localhost:3000
Contributions are always welcome!
Please adhere to this project's code of conduct
.
-
Fork the repo.
-
Create a new branch
git checkout -b feature/your-feature
-
Commit your changes following the commit guidelines
git commit -m 'Add some feature
-
Push your branch
git push origin feature/your-feature
-
Create a Pull Request.