Skip to content

GameSwift/gameswift-fe-template

Repository files navigation

Next.js Application Template

This repository contains a Next.js project template. It's designed to provide a solid foundation for building your Next.js applications, with a focus on simplicity, best practices, and modern development tools.

Features

  • Next.js: The core framework that powers the application.
  • TypeScript: This project is configured to use TypeScript for static type checking.
  • ESLint and Prettier: The project is set up with ESLint for linting and Prettier for code formatting.
  • Husky and lint-staged: These tools are used to ensure that all committed code is linted and formatted.
  • Commitizen and commitlint: These tools are used to enforce conventional commit messages.

Getting Started

To get started with this template, follow the steps below:

  1. Clone the repository: Clone this repository to your local machine.
  2. Install dependencies: Install the necessary dependencies by running yarn install.
  3. Run the development server: Start the development server by running yarn dev.
  4. Open the application: Open your web browser and navigate to http://localhost:3000 to see the application in action.
  5. Start editing: You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Scripts

This project includes the following npm scripts:

  • yarn dev: Starts the development server.
  • yarn build: Builds the application for production.
  • yarn start: Starts the application in production mode.
  • yarn type-check: Runs TypeScript to check for type errors.
  • yarn lint: Runs ESLint to catch issues.
  • yarn lint:fix: Runs ESLint to catch and fix issues.
  • yarn format: Runs Prettier to format all code.
  • yarn commit: Runs Commitizen for commit message prompts.
  • yarn reinstall: Deletes node_modules and yarn.lock, then reinstalls dependencies.