TGV

Project

TGV is a boilerplate for building websites with Vite.js, React, TypeScript, SCSS, deployed on GitHub Pages, it also features react-router navigation and json files for routes, navigation, content, assets. And a 404.html that redirects lost pages to the homepage using hashrouter.

Prerequisites

• A good understanding of GitHub Pages

Features

• Vite.js
• React
• TypeScript
• SCSS
• React-router
• Navigation
• Json files for routes, navigation, content.

To do

• Improve responsive assets
• More components

Installation

• Clone the repository
• Open a terminal in the project folder
• Run npm install to install the dependencies

Development

• Run npm run dev to start the development server

Deployement

• In package.json, change the homepage path to your repository name.
• Open a terminal in the project folder
• Run npm run deploy to deploy the project on GitHub Pages

Your are done.

Folder structure

• 404.html
• src
  • assets
    • images.tsx
  • data
    • nav.json
  • components
    • footer
      • index.tsx
      • index.scss
    • nav
      • index.tsx
      • index.scss
  • styles
    • utils
      • _breakpoints.scss
      • _colors.scss
      • _fonts.scss
      • _mixins.scss
  • pages
    • Root
      • index.tsx
      • index.scss
    • Home
      • index.tsx
      • index.scss
    • About
      • index.tsx
      • index.scss
  • main.tsx