Companion Dice For Tabletop Games
https://companiondice.netlify.app/
Features
- Select from 4, 6, 8, 10, 12, 20 sided dice
- Supports rolling multiple dice of one type
- Responsive Mobile friendly layout
- PWA Download as an offline Progressive Web App onto your phone
- NEW in 1.1 You can Now roll 100 sided, and roll for Ability Scores
Acknowledgement
Created in collaboration with Nathan Goullete
Built With
- ParcelJS Blazing fast, zero configuration web application bundler
- Preact Fast 3kB alternative to React with the same modern API
- postCSS tool for transforming CSS with JavaScript
- TailwindCSS A utility-first CSS framework for rapidly building custom designs
- Netlify - All-in-one platform for automating modern web projects
- Reach Router - Accessible Routing for React by managing the focus of your app on route transitions.
- Polished - lightweight toolset for writing styles in JavaScript
- PrettierJS - opinionated code formatter
- ESlint - Pluggable JavaScript linter
Contributing
Local Development Setup
- Clone project
- Navigate to project directory
- Open terminal in project directory and run
npm install
- Run
npm start
a dev server will open at localhost:1234
- Edit && Save will live update and refresh the page on the dev server
- Push to Remote after verifying functionality locally
Commit Guidelines
- commit subject lines should be 50 characters or less
- begin with an emoji write them with a keyword wrapped in colons
:book:
๐
- followed by a verb in the imperative ie: add, remove, compile
- ending with a reference to the relevant issue number with a hashtag and in parentheses ie:
(#24)
Example:
# emoji 50-character subject line (#25)
#
# Why:
#
Emojis to be used:
- ๐
:bug:
fix a bug
- ๐ฅ
:fire:
remove file or code
- ๐ฆ
:package:
bundle, compile build process code/files
- โจ
:sparkles:
add feature
- ๐
:sunglasses:
improve styles
- ๐ง
:construction:
Work in progress
- โป๏ธ
:recycle:
reformat or refactor code
- ๐
:book:
documentation
- ๐
:truck:
move files/change folders
Resources on emoji based commits
References && Resources
Using Tailwind
Download Details:
Author: AndreBClark
Demo: https://companiondice.netlify.app/dice/20
Source Code: https://github.com/AndreBClark/companiondice
#react #reactjs #javascript