TypeScript React App Skeleton

This repository serves as a skeleton for creating new TypeScript React applications. It includes basic setup and configurations to help you get started quickly.

Table of Contents

• Getting Started
  • Prerequisites
  • Forking the Repository
  • Cloning the Repository
  • Installing Dependencies
• Configuration
  • GitHub Pages Deployment
• Usage

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (version 14 or later)
• npm (version 6 or later)

Fork this Repository

Click the "Fork" button at the top right corner of the page to create a copy of the repository under your GitHub account.

Cloning the Repository

1. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/your-forked-repo-name.git

2. Navigate to the project directory:

   cd your-forked-repo-name

Installing Dependencies

Install the necessary dependencies using npm:

npm install

Configuration

GitHub Pages Deployment

1. Update the homepage field in package.json to match your GitHub Pages URL:

   "homepage": "https://your-username.github.io/your-forked-repo-name"

2. Install the gh-pages package if it's not already installed:

   npm install --save gh-pages

3. Add the following scripts to your package.json:

   "scripts": {
     "predeploy": "npm run build",
     "deploy": "gh-pages -d build"
   }

4. Deploy your app to GitHub Pages:

   npm run deploy

Usage

Start the development server:

npm start

Open your browser and navigate to http://localhost:3000 to see your app in action.