Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.58 KB

README.md

File metadata and controls

32 lines (19 loc) · 1.58 KB
Raw

React + GitHub Pages

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules, and it also includes automatic deployment to GitHub Pages using GitHub Actions.

Features

  • React and Vite: A minimal boilerplate for setting up a React project within the Vite build tool.
  • HMR (Hot Module Replacement): Enjoy fast development with Hot Module Replacement for real-time updates.
  • ESLint Rules: Pre-configured ESLint rules for maintaining code quality.

Additional Features

In addition to the core features mentioned above, this template comes with some additional features:

  • GitHub Pages Deployment: Set up and configure a GitHub Actions script that automatically builds and deploys your React application to GitHub Pages. This ensures that your project is accessible to a wider audience with minimal effort.

Getting Started

To get started with this template, simply follow these steps:

  1. Clone this repository.
  2. Install dependencies using npm install or yarn install.
  3. Start the development server with npm run dev or yarn dev.
  4. Begin building your React application within the Vite environment.

Deployment

The project is set up to automatically deploy to GitHub Pages. Just push your changes to the main branch, and the GitHub Actions workflow will take care of the rest.

For more information, refer to the GitHub Pages documentation to configure your repository's settings for GitHub Pages deployment.

Feel free to customize this README and your project further as needed. Happy coding!