scaccoman/wheel-of-names

Wheel of names

Wheel of Names

Welcome to the Wheel of Names repository! This is a simple yet visually appealing static website for spinning a wheel of names, built with love (and a bit of chaos).

Why This Exists

I created this because I couldn't find a dead simple wheel of names website that:

• Had no tracking or advertising
• Looked visually attractive
• Wasn't trying to monetize a simple functionality

Seriously, it's just a static website! It costs next to nothing to run, and there's no reason to bombard users with ads or track their every move.

Disclaimer

The code is beyond horrible. I hacked this together in a couple of days, so please don't judge me.

Included Tools & Technologies

Despite the rushed nature of this project, it uses a solid stack of modern web technologies:

• React
• ESLint
• Webpack
• Jest
• Prettier
• TypeScript
• Husky

Structure

Page components go into src/pages/* and UI components into src/components/*. Both pages and components follow the same structure, consisting of the following files:

• const.ts - exports the component CLASS_NAME and any other constants
• props.ts - provides defaultProps and propTypes
• types.ts - defines an interface for the component propTypes
• style.scss - component stylesheet, imported in index.tsx
• index.tsx - the component itself

Scripts

• yarn start: starts the dev server and opens the index page in a browser
• yarn build: builds the application to the dist folder for Release
• yarn format: runs Prettier
• yarn lint: runs ESLint
• yarn test: runs Jest
• yarn test:coverage: runs Jest and outputs coverage results
• yarn test:watch: runs Jest and runs tests on changes
• yarn test:snapshots: runs Jest and updates snapshots
• yarn update-version: updates CHANGELOG.md, bumps & tags the version
• yarn prepare: installs Husky hooks
• yarn prepare-release: lints, tests, and builds
• yarn release: runs prepare-release and update-version

Release History

See CHANGELOG.md for more information.

License

Distributed under the MIT license. See LICENSE.md for more information.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

---

Enjoy spinning your wheels, ad-free and hassle-free!