Skip to content
/ template--next-ts Public template

My template for easy and quick creation of new projects on next. If anyone has any suggestions on how to improve it, you can contact me!

License

Notifications You must be signed in to change notification settings

nert1n/template--next-ts

Repository files navigation

<PROJECT NAME> logo

Template - Frontend Web Application

Template is a feature-rich frontend application built using modern technologies like React, TypeScript, and Vite. It offers a fast and scalable platform for developers to collaborate and share coding knowledge.

Live demo: Visit Template

Design files: Figma

Table of Contents

Features

  • Fast and Scalable: Built using Vite and React for optimal performance.
  • Type-Safe: Uses TypeScript for catching errors at compile time.
  • Rich Routing: Implements client-side routing with React Router.
  • Form Management: Handles form validation with React Hook Form.
  • Code Quality: Ensures consistent styling with ESLint, Prettier, and Stylelint.
  • End-to-End Testing: E2E tests using Playwright.

Tech-Stack

  • NEXT: JavaScript library for building user interfaces
  • TypeScript: Typed superset of JavaScript for better maintainability

Getting Started

Prerequisites

  • Node.js: Ensure you have Node.js installed (>=18.x).
  • pnpm: Use pnpm as the package manager for consistency.

Installation

Clone the repository and install dependencies:

git clone https://github.com/
cd Template
pnpm install

Running Locally

Start the development server:

pnpm dev

Linting and Formatting

To ensure code quality:

pnpm lint
pnpm format

Folder Structure

This project uses the Feature-Sliced Design (FSD) architecture:

src/
  ├── app/          # App-level settings, providers, and configuration
  ├── entities/     # Business entities (e.g., User, Post)
  ├── features/     # Application features (e.g., Auth, Profile)
  ├── shared/       # Shared components, utils, styles, etc.
  ├── pages/        # Top-level routes and layout components
  ├── widgets/      # UI widgets for composition

Contributing

We welcome contributions! Follow these steps to get started:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Commit your changes (git commit -m 'Add your feature')
  4. Push the branch (git push origin feature/your-feature)
  5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

My template for easy and quick creation of new projects on next. If anyone has any suggestions on how to improve it, you can contact me!

Topics

Resources

License

Security policy

Stars

Watchers

Forks