|
| 1 | +# HPSC website |
| 2 | + |
| 3 | +## Table of Contents |
| 4 | + |
| 5 | +- [Description](#description) |
| 6 | +- [Summary](#summary) |
| 7 | +- [Repository](#repository) |
| 8 | +- [Structure](#structure) |
| 9 | +- [Technology](#technology) |
| 10 | +- [Instructions](#instructions) |
| 11 | +- [Screenshots](#screenshots) |
| 12 | +- [License](#license) |
| 13 | +- [Author](#author) |
| 14 | + |
| 15 | +## Description |
| 16 | + |
| 17 | +This repository contains the source code for the Hartbeespoortdam Practical Shooting Club (HPSC) website. |
| 18 | + |
| 19 | +## Summary |
| 20 | + |
| 21 | +The [HPSC website](https://hpsc.co.za) uses modern web technologies |
| 22 | +to provide an informative and user-friendly platform for members and visitors.<br/> |
| 23 | +The primary technologies used in this project include TypeScript, SCSS, and MDX. |
| 24 | + |
| 25 | +## Repository |
| 26 | + |
| 27 | +The repository for this project is located at |
| 28 | +[GitHub](https://github.com/tahoni/hpsc-web-vite). |
| 29 | + |
| 30 | +Feature requests, suggestions for improvements and bugs can be |
| 31 | +logged using the project's [Issues](https://github.com/tahoni/hpsc-web-vite/issues) page. |
| 32 | + |
| 33 | +An overview of the project can be found at |
| 34 | +[https://tahoni.info/projects/hpsc-web-vite](https://www.tahoni.info/projects/hpsc-web-vite). |
| 35 | + |
| 36 | +## Structure |
| 37 | + |
| 38 | +A high-level structure of the project. |
| 39 | + |
| 40 | +```text |
| 41 | +├───.github |
| 42 | +│ └───workflows |
| 43 | +├───builders |
| 44 | +├───documentation |
| 45 | +│ └───screenshots |
| 46 | +├───public |
| 47 | +│ └───assets |
| 48 | +│ └───images |
| 49 | +│ ├───club |
| 50 | +│ ├───content |
| 51 | +│ ├───layout |
| 52 | +│ └───logos |
| 53 | +└───src |
| 54 | + ├───assets |
| 55 | + │ ├───fonts |
| 56 | + │ │ └───icomoon |
| 57 | + │ ├───images |
| 58 | + │ │ ├───icons |
| 59 | + │ │ └───ids |
| 60 | + │ └───stylesheets |
| 61 | + ├───components |
| 62 | + │ ├───Captcha |
| 63 | + │ ├───Map |
| 64 | + │ ├───Sidebar |
| 65 | + │ ├───Text |
| 66 | + │ └───Title |
| 67 | + ├───config |
| 68 | + ├───constants |
| 69 | + │ ├───about |
| 70 | + │ └───images |
| 71 | + ├───content |
| 72 | + │ ├───pages |
| 73 | + │ │ ├───AboutUs |
| 74 | + │ │ ├───History |
| 75 | + │ │ ├───Home |
| 76 | + │ │ └───Links |
| 77 | + │ └───posts |
| 78 | + │ ├───Events |
| 79 | + │ ├───Members |
| 80 | + │ └───Venues |
| 81 | + ├───enums |
| 82 | + ├───forms |
| 83 | + │ └───ContactUs |
| 84 | + ├───helpers |
| 85 | + ├───layout |
| 86 | + │ ├───Body |
| 87 | + │ ├───Breakpoints |
| 88 | + │ ├───Content |
| 89 | + │ ├───Footer |
| 90 | + │ └───Header |
| 91 | + ├───model |
| 92 | + ├───pages |
| 93 | + │ ├───AboutUs |
| 94 | + │ ├───ContactUs |
| 95 | + │ ├───Events |
| 96 | + │ ├───History |
| 97 | + │ ├───Home |
| 98 | + │ ├───Links |
| 99 | + │ ├───Members |
| 100 | + │ ├───News |
| 101 | + │ └───Venues |
| 102 | + ├───services |
| 103 | + ├───templates |
| 104 | + │ └───ContactUs |
| 105 | + └───utils |
| 106 | +``` |
| 107 | + |
| 108 | +## Technology |
| 109 | + |
| 110 | +### Overview |
| 111 | + |
| 112 | +This is a React project bootstrapped using Vite with the TypeScript React template. |
| 113 | + |
| 114 | +It is written in TypeScript and uses both JSX and MDX components. |
| 115 | + |
| 116 | +Bootstrap and React Bootstrap are used for the UI/UX.<br/> |
| 117 | +Styling is done by SCSS stylesheets. |
| 118 | + |
| 119 | +React Router is used for page routing. |
| 120 | + |
| 121 | +### Technology Stack |
| 122 | + |
| 123 | +#### Languages: |
| 124 | + |
| 125 | +- TypeScript 5 |
| 126 | + |
| 127 | + [](https://www.typescriptlang.org/) |
| 128 | + |
| 129 | +- HTML 5 |
| 130 | + |
| 131 | + [](https://www.w3.org/) |
| 132 | + |
| 133 | +- CSS 3 |
| 134 | + |
| 135 | + [](https://www.w3.org/) |
| 136 | + |
| 137 | +#### Build Tools: |
| 138 | + |
| 139 | +- npm 10 |
| 140 | + |
| 141 | + [](https://www.npmjs.com/) |
| 142 | + |
| 143 | +#### Frameworks: |
| 144 | + |
| 145 | +- Vite 6 |
| 146 | + |
| 147 | + [](https://vitejs.dev/) |
| 148 | + |
| 149 | +- React 19 |
| 150 | + |
| 151 | + [](https://react.dev/) |
| 152 | + |
| 153 | +#### Libraries: |
| 154 | + |
| 155 | +- Bootstrap 5 |
| 156 | + |
| 157 | + [](https://getbootstrap.com/) |
| 158 | + |
| 159 | +- React Bootstrap 2 |
| 160 | + |
| 161 | + [](https://react-bootstrap.github.io/) |
| 162 | + |
| 163 | +- React Router 6 |
| 164 | + |
| 165 | + [](https://reactrouter.com/en/main) |
| 166 | + |
| 167 | +## Instructions |
| 168 | + |
| 169 | +The following commands are available in this project |
| 170 | +to set up the development environment |
| 171 | +and build the production environment. |
| 172 | + |
| 173 | +#### `npm install` |
| 174 | + |
| 175 | +This installs the dependencies. |
| 176 | + |
| 177 | +#### Environment Variables |
| 178 | + |
| 179 | +The npm key to @tahoni on GitHub needs |
| 180 | +to be set in the `GITHUB_TOKEN` environment variable, |
| 181 | +to load the `tahoni-lib-react` npm package. |
| 182 | + |
| 183 | +The Google Maps API key from Google Cloud Services needs |
| 184 | +to be set in the `GOOGLE_MAPS_API_KEY` environment variable, |
| 185 | +otherwise, the map will not be available. |
| 186 | + |
| 187 | +The Google reCAPTCHA site key from Google Cloud Services needs |
| 188 | +to be set in the `RECAPTCHA_V2_SITE_KEY` environment variable, |
| 189 | +otherwise, the CAPTCHA will break. |
| 190 | + |
| 191 | +#### `npm run dev` |
| 192 | + |
| 193 | +This runs the app in development mode.<br/> |
| 194 | +The page will reload if you make edits. |
| 195 | + |
| 196 | +#### `npm run build` |
| 197 | + |
| 198 | +This builds the app for production to the `dist` folder.<br/> |
| 199 | +Your app is ready to be deployed! |
| 200 | + |
| 201 | +#### `npm run preview` |
| 202 | + |
| 203 | +This previews the app locally in the `dist` folder.<br/> |
| 204 | +Use this to check if the production build looks OK in your local environment. |
| 205 | + |
| 206 | +<!-- TODO: help on how to generate sitemap --> |
| 207 | + |
| 208 | +## Screenshots |
| 209 | + |
| 210 | +<!-- TODO: update screenshots --> |
| 211 | + |
| 212 | +### History Page |
| 213 | + |
| 214 | + |
| 215 | + |
| 216 | +## License |
| 217 | + |
| 218 | +Copyright © 2025 Hartbeespoortdam Practical Shooting Club.<br/> |
| 219 | +All Rights Reserved. |
| 220 | + |
| 221 | +## Author |
| 222 | + |
| 223 | +**Leoni Lubbinge** |
| 224 | + |
| 225 | +- [](https://www.tahoni.info) |
| 226 | +- [](mailto:leonil@tahoni.info) |
| 227 | + |
| 228 | +- [](mailto:tahoni@outlook.com) |
| 229 | +- [](mailto:tahoni@gmail.com) |
| 230 | +- [](https://github.com/tahoni) |
| 231 | +- [](https://www.linkedin.com/in/leoni-lubbinge-06066b16/) |
0 commit comments