Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuryalencar/clean-frontend-template
Sample of the frontend project using NextJS easy to understand and use.
https://github.com/yuryalencar/clean-frontend-template
eslint husky nextjs nextjs14 prettier template template-project typescript
Last synced: 6 days ago
JSON representation
Sample of the frontend project using NextJS easy to understand and use.
- Host: GitHub
- URL: https://github.com/yuryalencar/clean-frontend-template
- Owner: yuryalencar
- License: mit
- Created: 2024-03-17T14:29:52.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-17T19:09:41.000Z (8 months ago)
- Last Synced: 2024-03-18T15:46:19.500Z (8 months ago)
- Topics: eslint, husky, nextjs, nextjs14, prettier, template, template-project, typescript
- Language: TypeScript
- Homepage:
- Size: 116 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Clean Frontend: A frontend template to build good solutions too easy.
This is a template for a frontend project built with TypeScript, Next.js, and Tailwind CSS.
## Features
- **TypeScript**: Type-safe JavaScript superset for building scalable applications.
- **Next.js**: React framework for server-rendered applications with easy page-based routing.
- **Tailwind CSS**: Utility-first CSS framework for quickly styling your applications.
- **Husky**: Git hooks made easy to automate linting and other tasks.
- **ESLint**: Pluggable JavaScript linter for identifying and fixing problems in code.
- **Git Commit Message Linter**: Enforce consistent and meaningful commit messages.
## Getting Started
1. Clone this repository:
```bash
git clone https://github.com/your-username/frontend-project-template.git
```
2. Navigate into the project directory:
```bash
cd clean-frontend-template
```
3. Install dependencies:
```bash
pnpm install # first option
yarn install # second option
npm install # third option
```
## Usage
Run the development server:
```bash
pnpm dev # first option
yarn dev # second option
npm run dev # third option
```
## Linting and Formatting
This project includes ESLint for linting JavaScript and TypeScript files, Prettier for code formatting, and Husky to automatically run linting and formatting checks before committing your code.
To manually run linting:
```bash
pnpm lint # first option
yarn lint # second option
npm run lint # third option
```
Prettier is integrated into the linting process and will automatically format your code to adhere to the defined code style rules. However, you can also manually format your code using the following command:
```bash
pnpm format # first option
yarn format # second option
npm run format # third option
```
## Commit Message Linting
This project enforces consistent and meaningful commit messages using Commitlint. Make sure to follow the conventional commit message format when committing changes.
## Contributing
Feel free to contribute to this project by opening issues or submitting pull requests. Please follow the existing code style and conventions.