diff options
| author | Brendan F <EpicWolverine@users.noreply.github.com> | 2023-05-14 23:12:27 -0700 |
|---|---|---|
| committer | Brendan F <EpicWolverine@users.noreply.github.com> | 2023-05-14 23:12:27 -0700 |
| commit | 737344a72d23dc97b0d0e73cc4ab7fdffd0fbf49 (patch) | |
| tree | 2a915b59ab29ac79012ca3345999d9e23562d1f9 /README.md | |
| parent | b19a001171bd8197a30f397091d67eba5e4c1111 (diff) | |
Merge in react app code
From sluchajfun and youtube-heardle-template
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 47 insertions, 0 deletions
@@ -4,3 +4,50 @@ 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". + +[](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! |
