|
| 1 | +# Client |
| 2 | +## Table of content |
| 3 | + |
| 4 | +<!-- vim-markdown-toc GFM --> |
| 5 | + |
| 6 | +* [Introduction](#introduction) |
| 7 | +* [Directories](#directories) |
| 8 | + * [<img src="../assets/folder-images.svg" style="height: 30px; display: inline; transform: translateY(5px)"> assets](#img-srcassetsfolder-imagessvg-styleheight-30px-display-inline-transform-translatey5px-assets) |
| 9 | + * [icons](#icons) |
| 10 | + * [imgs](#imgs) |
| 11 | + * [Other](#other) |
| 12 | + * [<img src="../assets/folder-components.svg" style="height: 30px; display: inline; transform: translateY(5px)"> components](#img-srcassetsfolder-componentssvg-styleheight-30px-display-inline-transform-translatey5px-components) |
| 13 | + * [<img src="../assets/folder-json.svg" style="height: 30px; display: inline; transform: translateY(5px)"> data](#img-srcassetsfolder-jsonsvg-styleheight-30px-display-inline-transform-translatey5px-data) |
| 14 | + * [<img src="../assets/folder-font.svg" style="height: 30px; display: inline; transform: translateY(5px)"> fonts](#img-srcassetsfolder-fontsvg-styleheight-30px-display-inline-transform-translatey5px-fonts) |
| 15 | + * [<img src="../assets/folder-hook.svg" style="height: 30px; display: inline; transform: translateY(5px)"> hooks](#img-srcassetsfolder-hooksvg-styleheight-30px-display-inline-transform-translatey5px-hooks) |
| 16 | + * [<img src="../assets/folder-layout.svg" style="height: 30px; display: inline; transform: translateY(5px)"> layout](#img-srcassetsfolder-layoutsvg-styleheight-30px-display-inline-transform-translatey5px-layout) |
| 17 | + * [<img src="../assets/folder-views.svg" style="height: 30px; display: inline; transform: translateY(5px)"> pages](#img-srcassetsfolder-viewssvg-styleheight-30px-display-inline-transform-translatey5px-pages) |
| 18 | + * [<img src="../assets/folder-python.svg" style="height: 30px; display: inline; transform: translateY(5px)"> python](#img-srcassetsfolder-pythonsvg-styleheight-30px-display-inline-transform-translatey5px-python) |
| 19 | + * [<img src="../assets/folder-sass.svg" style="height: 30px; display: inline; transform: translateY(5px)"> style](#img-srcassetsfolder-sasssvg-styleheight-30px-display-inline-transform-translatey5px-style) |
| 20 | + * [<img src="../assets/folder-utils.svg" style="height: 30px; display: inline; transform: translateY(5px)"> utils](#img-srcassetsfolder-utilssvg-styleheight-30px-display-inline-transform-translatey5px-utils) |
| 21 | + |
| 22 | +<!-- vim-markdown-toc --> |
| 23 | + |
| 24 | +## Introduction |
| 25 | +- The front-end is written in [TypeScript](https://www.typescriptlang.org/).<br/> |
| 26 | +- The framework used is [Solid.JS](https://www.solidjs.com).<br/> |
| 27 | +- The meta language used to style the page is [Sass](https://sass-lang.com).<br/> |
| 28 | +- The application is bundled with [Webpack](https://webpack.js.org/).<br/> |
| 29 | +- The environment of the application is [Vite](https://vitejs.dev/).<br/> |
| 30 | + |
| 31 | +## Directories |
| 32 | +### <img src="../assets/folder-images.svg" style="height: 30px; display: inline; transform: translateY(5px)"> assets |
| 33 | +The directory in which there are the assets of WeekGolf |
| 34 | +#### icons |
| 35 | +Files ending in `.svg` |
| 36 | +#### imgs |
| 37 | +Files ending in `.jpe?g`, `.png`, `.webp` |
| 38 | +#### Other |
| 39 | +All the other files are some files that are also images but that are specific images |
| 40 | + |
| 41 | +### <img src="../assets/folder-components.svg" style="height: 30px; display: inline; transform: translateY(5px)"> components |
| 42 | +In this directory there are files in `.tsx` that represents a component.<br/> |
| 43 | +A component is a piece of code that does a specific task.<br/> |
| 44 | +For example a Toggle switch On/Off can be a component. |
| 45 | + |
| 46 | +### <img src="../assets/folder-json.svg" style="height: 30px; display: inline; transform: translateY(5px)"> data |
| 47 | +In this directory, the majority of the files are in `.json`.<br/> |
| 48 | +This directory is mainly used to store data that will be reused later by components. |
| 49 | + |
| 50 | +### <img src="../assets/folder-font.svg" style="height: 30px; display: inline; transform: translateY(5px)"> fonts |
| 51 | +In this directory, there are all the fonts (files ending in `.ttf`) used by WeekGolf. |
| 52 | + |
| 53 | +### <img src="../assets/folder-hook.svg" style="height: 30px; display: inline; transform: translateY(5px)"> hooks |
| 54 | +In this directory there are files in `.tsx?` that represents a hook.<br/> |
| 55 | +A hook is a tool used in website design to allow the webpage to be interactive and dynamic.<br/> |
| 56 | +It enables certain parts of the webpage to be identified and manipulated, which can change how the page looks or behaves.<br/> |
| 57 | +It works like a hook in fishing, where a fisherman catches fish by using a hook.<br/> |
| 58 | +Similarly, a hook "catches" certain parts of a webpage and allows them to be changed. |
| 59 | + |
| 60 | +### <img src="../assets/folder-layout.svg" style="height: 30px; display: inline; transform: translateY(5px)"> layout |
| 61 | +In this directory there are files in `.tsx` that represents a layout-component.<br/> |
| 62 | +layout-components are defined as a component that is used for the layout, like a navbar, a header or a footer for example. |
| 63 | + |
| 64 | +### <img src="../assets/folder-views.svg" style="height: 30px; display: inline; transform: translateY(5px)"> pages |
| 65 | +In this directory there are files in `.tsx` that represents a page in WeekGolf.<br/> |
| 66 | + |
| 67 | +### <img src="../assets/folder-python.svg" style="height: 30px; display: inline; transform: translateY(5px)"> python |
| 68 | +In this directory there are files in `.py` that are some short python scripts.<br/> |
| 69 | +It's useful for creating separate small scripts that are still related to the project |
| 70 | + |
| 71 | +### <img src="../assets/folder-sass.svg" style="height: 30px; display: inline; transform: translateY(5px)"> style |
| 72 | +In this directory there are files in `.scss` that are just stylesheets written in sass. |
| 73 | + |
| 74 | +### <img src="../assets/folder-utils.svg" style="height: 30px; display: inline; transform: translateY(5px)"> utils |
| 75 | +In this directory there are files in `.tsx?` that are useful functions that are going to be used in components. |
0 commit comments