Overview:
This product is a Next.js application with a directory structure that includes app routers. It uses React, Typescript, and Tailwind CSS. It also includes Contentlayer with MDX plugins for content management, SEO metadata, ESLint for code problem detection and fixing, Prettier for code formatting, Husky & Lint Staged to run scripts on staged files, and Conventional Commit Lint for commit message linting. The project can be cloned and customized according to the user’s requirements.
Features:
- Next.js with app router directory structure: Next.js framework is used with a directory structure that includes app routers.
- React: The application is built using the React library for building user interfaces.
- Typescript: Typescript is used for static type checking and improved developer productivity.
- Tailwind CSS: The application is styled using Tailwind CSS, a utility-first CSS framework.
- Contentlayer with MDX plugins: Contentlayer with MDX plugins is used for managing content in the application.
- SEO metadata: SEO metadata is included to improve the visibility and ranking of the website on search engines.
- ESLint: ESLint is used to find and fix problems in the code, improving code quality.
- Prettier: Prettier is used to format the code consistently, making it easier to read and maintain.
- Husky & Lint Staged: Husky & Lint Staged are used to run scripts on staged files before they are committed, ensuring code quality.
- Conventional Commit Lint: Conventional Commit Lint is used to enforce commit message linting, improving commit history readability.
Installation:
To run this project locally, follow the steps below:
- Clone this repository.
- Change to the project directory.
- Install the project dependencies.
- Create a
.envfile similar to.env.exampleand input the required environment variables. - Start working on the project.
To customize the project, you can modify various files such as lib/metadata.ts, app/about/page.tsx, app/resume/page.tsx, public/share/resume.pdf, public/static, tailwind.config.js, content, and next.config.js.
Summary:
This product is a Next.js application with a directory structure, incorporating features such as React, Typescript, Tailwind CSS, and Contentlayer with MDX plugins. It also includes various tools for code quality and formatting, such as ESLint and Prettier. The installation guide allows users to easily set up and customize the project. Overall, this project provides a solid foundation for building web applications with Next.js.