Skip to content

Commit 919b203

Browse files
committed
Changing everything
1 parent 1d6e46e commit 919b203

File tree

846 files changed

+68948
-19
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

846 files changed

+68948
-19
lines changed

CODE_OF_CONDUCT.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Code of Conduct
2+
## Table of content
3+
4+
<!-- vim-markdown-toc GFM -->
5+
6+
* [Our Pledge](#our-pledge)
7+
* [Our Standards](#our-standards)
8+
* [Our Responsibilities](#our-responsibilities)
9+
* [Scope](#scope)
10+
* [Enforcement](#enforcement)
11+
12+
<!-- vim-markdown-toc -->
13+
14+
15+
## Our Pledge
16+
We, as contributors and maintainers of this project, pledge to create a welcoming and inclusive environment for everyone, regardless of age, body size, disability, ethnicity ,level of experience, nationality, personal appearance, religion, or sexual identity and orientation.
17+
18+
## Our Standards
19+
We are committed to fostering a positive and respectful community that encourages collaboration and inclusivity. We do not tolerate any form of discrimination, harassment, or offensive behavior, including but not limited to:
20+
21+
- Verbal or written comments that are derogatory, offensive, or exclusionary
22+
- Threats, intimidation, or bullying
23+
- Discriminatory jokes or language
24+
- Posting sexually explicit or violent content
25+
- Inappropriate or unwelcome physical contact
26+
- Unwanted advances or attention
27+
28+
## Our Responsibilities
29+
As contributors and maintainers of this project, we are responsible for ensuring that our community is free of discrimination and harassment, and that everyone feels safe and respected. We will take appropriate action in response to any reported incidents of unacceptable behavior, including but not limited to:
30+
31+
- Investigating any reported incidents promptly and thoroughly
32+
- Providing support to anyone affected by discrimination or harassment
33+
- Enforcing consequences for any behavior that violates this code of conduct, including but not limited to warning the offender or revoking their privileges to participate in the project
34+
35+
## Scope
36+
This code of conduct applies to all contributors and maintainers of this project, both online and in person.
37+
38+
## Enforcement
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected] All complaints will be reviewed and investigated promptly and fairly. The project team is obligated to maintain confidentiality with regard to the reporter of an incident, unless doing so would cause harm to the community or is required by law.

CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to WeekGolf
2+
## Table of content
3+
4+
<!-- vim-markdown-toc GFM -->
5+
6+
* [Introduction](#introduction)
7+
* [How to Contribute](#how-to-contribute)
8+
* [Reporting Bugs](#reporting-bugs)
9+
* [Suggesting Enhancements](#suggesting-enhancements)
10+
* [Contributing Code](#contributing-code)
11+
* [Fork the repository on GitHub](#fork-the-repository-on-github)
12+
* [Improving Documentation](#improving-documentation)
13+
* [Code of Conduct](#code-of-conduct)
14+
15+
<!-- vim-markdown-toc -->
16+
17+
## Introduction
18+
Thank you for your interest in contributing to WeekGolf! We welcome all contributions, including bug reports, feature requests, code changes, and documentation improvements. By contributing to this project, you agree to abide by the Code of Conduct.
19+
20+
## How to Contribute
21+
### Reporting Bugs
22+
If you find a bug in WeekGolf, please open an issue on GitHub. When opening a new issue, please provide a detailed description of the problem, including steps to reproduce it and any error messages or logs you may have. Please also include the version of WeekGolf you are using and any relevant information about your operating system or environment.
23+
24+
### Suggesting Enhancements
25+
If you have an idea for a new feature or enhancement to WeekGolf, please open an issue on GitHub and describe your suggestion in as much detail as possible. This may include use cases, user stories, or any other information that can help us understand your idea. Please note that we cannot guarantee that every suggestion will be implemented, but we appreciate all feedback and ideas.
26+
27+
### Contributing Code
28+
If you are interested in contributing code to WeekGolf, please follow these steps:
29+
30+
### Fork the repository on GitHub
31+
Clone your fork to your local machine
32+
Create a new branch for your changes
33+
Make your changes and commit them to your branch
34+
Push your branch to your fork on GitHub
35+
Open a pull request against the original repository
36+
When creating your pull request, please provide a detailed description of the changes you made, including any relevant background or context. Please also ensure that your code follows the project's coding standards and is well-documented. We appreciate your contributions and will do our best to review and merge pull requests as quickly as possible.
37+
38+
### Improving Documentation
39+
If you notice any errors or omissions in WeekGolf's documentation, or if you would like to suggest improvements, please open an issue on GitHub or submit a pull request with your changes. We welcome any feedback that can help us improve our documentation and make it more useful for users.
40+
41+
## Code of Conduct
42+
Please note that all contributors are expected to follow the Code of Conduct for this project. This code outlines our expectations for behavior within the project community, as well as the consequences for unacceptable behavior.
43+
44+
Thank you again for your contributions to WeekGolf!

Client/.babelrc

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"presets": [
3+
[
4+
"@babel/preset-env",
5+
{
6+
"targets": {
7+
"node": "current"
8+
}
9+
}
10+
]
11+
]
12+
}

Client/README.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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.

Client/index.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1" />
6+
<meta name="theme-color" content="#33CC33" />
7+
<meta name="og:image" content="http://localhost:3000/src/assets/imgs/weekgolf.png" />
8+
<link rel="shortcut icon" type="image/ico" href="/src/assets/favicon.ico" />
9+
<link rel="apple-touch-icon" sizes="180x180" href="/src/assets/apple-touch-icon.png" />
10+
<link rel="icon" type="image/png" sizes="32x32" href="/src/assets/favicon-32x32.png" />
11+
<link rel="icon" type="image/png" sizes="16x16" href="/src/assets/favicon-16x16.png" />
12+
<link rel="manifest" href="/site.webmanifest">
13+
<title>WeekGolf</title>
14+
</head>
15+
<body style="background-color: black;">
16+
<noscript>You need to enable JavaScript to run this app.</noscript>
17+
<div id="root"></div>
18+
19+
<script src="/src/index.tsx" type="module"></script>
20+
</body>
21+
</html>

0 commit comments

Comments
 (0)