HPSC Website

The official repository for the Hartbeespoortdam Practical Shooting Club (HPSC) website.

Table of Contents

• Introduction
• Repository
• Technology
• Instructions
  • Install the Project
  • Available Scripts
  • Environment Variables
• Architecture
• User Interface
• License
• Author

Introduction

The HPSC website uses modern web technologies to provide an informative and user-friendly platform for members and visitors.

The primary technologies used in this project include TypeScript, SCSS and MDX.

Repository

The repository for this project is located at GitHub.

Feature requests, suggestions for improvements and bugs can be logged using the project's Issues page.

Technology

This is a React project bootstrapped using Vite with the TypeScript React template.

It is written in TypeScript and uses both JSX and MDX components.

Bootstrap and React Bootstrap are used for the UI/UX. Styling is done by SCSS stylesheets.

React Router is used for page routing.

Instructions

You can download Node.js from here.

Clone the project from GitHub.

Install the project

Install the project using npm install.

Run it locally with npm run dev.

It will load at http://localhost:5173/. This page will reload if you make edits.

Build it for production with npm run build to the dist directory.

The production build can be verified by running npm run preview.

Available Scripts

The following commands are available in this project.

npm install

This installs the dependencies.

npm run dev

This runs the app in development mode. The page will reload if you make edits.

npm run build

This builds the app for production to the dist directory. Your app is ready to be deployed!

npm run preview

This previews the app locally in the dist directory. Use this to check if the production build looks OK in your local environment.

npm run lint

Runs ESLint to check for code quality issues.

npm run docs

Generates technical documentation using TypeDoc to the tsdocs directory.

Environment Variables

A npm read key to @tahoni on GitHub needs to be set in the GITHUB_TOKEN environment variable, to load the tahoni-lib-react npm package.

The Google Maps API key from Google Cloud Services needs to be set in the GOOGLE_API_KEY environment variable, otherwise, the map will not be available.

Architecture

A detailed explanation of the architecture can be found in the ARCHITECTURE.md file.

User Interface

A description of the user interface can be found in the UI.md file.

License

The copyright licence can be found in the LICENSE.md file.

Author

Leoni Lubbinge

• 

• 

• 

• 

•