Next.js Boilerplate

A minimal and customizable template for building modern web applications using Next.js.

Project Details

• Project Name: Next.js Boilerplate
• Description: My personal template for Next.js
• Author: Pavel Kuzyakin kuzyak.in
• Version: 1.0.0

Features

• Next.js: Fast server-side rendering and static site generation.
• TypeScript: Enhances code quality with static typing.
• ESLint: Ensures consistent code style.
• Sass/SCSS: Simplifies styling using SCSS.
• Project Structure: Clear folder organization for maintainability.
• Environment Variables: Easy configuration for different environments.

Getting Started

Prerequisites

• Node.js (version 16 or higher)
• npm

Installation

1. Clone the repository:

   git clone https://github.com/iposho/next-js-boilerplate.git
   cd next-js-boilerplate

2. Install dependencies:

   npm install

Development

To start the development server:

npm run dev

The application will be available at http://localhost:5000.

Building for Production

To build the application for production:

npm run build

The build will be created in the .next directory.

Testing

Currently, tests are not set up. You can add them as needed.

Project Structure

• /src: Main source code, including components and styles.
• /public: Static files and assets.
• /styles: Global and component-specific styles.
• /tests: Tests for components (can be added in the future).

Scripts

• dev: Start the development server.
• build: Build for production.
• start: Run the production server.
• lint: Lint code with ESLint.

Configuration

• Environment Variables: Use .env.local for managing environment variables.
• ESLint: Configuration is in .eslintrc.json.
• Stylelint: Configuration is in .stylelintrc.json.

Contributing

Contributions are welcome! Please submit issues or pull requests.

License

This project is licensed under the MIT License.

---

This README was generated with the assistance of ChatGPT.