aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 1e635447575123dd9ffacc4a4187b4964351e4a1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# PersonalHeardle

https://epicwolverine-heardle.glitch.me/

When they get CNAMEs working again, use
http://heardle.epicwolverine.com/


# Słuchaj.fun and Heardle Template
Forked from [Shizerq/sluchajfun](https://github.com/Shizerq/sluchajfun) and [sarvarghese/youtube-heardle-template](https://github.com/sarvarghese/youtube-heardle-template).

Clone of famous (now defunct) [Heardle](https://heardle.app) - "that daily music game".

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Tech stack
* [React](https://reactjs.org)
* [TypeScript](https://www.typescriptlang.org)
* [styled-components](https://styled-components.com)
* [YouTube iFrame API](https://developers.google.com/youtube/iframe_api_reference)

## To do
* Add Storybook
* Add tests
* Disable/bypass iFrame's Media Session API

## Contributing
Please format the code with ESLint and Prettier.

`npx eslint src/ --fix`

## Building (default React stuff)

In the project directory, you can run:

### `yarn`
Installs all the required dependencies.

### `yarn start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage