diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 54 |
1 files changed, 5 insertions, 49 deletions
@@ -1,50 +1,6 @@ -# PersonalHeardle +# k-heardle -https://heardle.epicwolverine.com -(replaces https://epicwolverine-heardle.glitch.me) - -# 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! +```bash +pnpm i +pnpm dev +``` |