/dice-roller-js

A simple dice roller built with NodeJS. Designed to run as a cloud function in Google's Firebase.

Primary LanguageTypeScriptMIT LicenseMIT

CodeFactor Codeship Status for CoreyT355/dice-roller-js

DiceRollerJS

Simple dice roller built as a Firebase Function.

Getting Started

Clone the repo. Get a Firebase account Install the Firebase CLI. You will need to log in to the CLI to deploy. Run npm i Run npm run serve to run locally and test Edit the .firebaserc to set your project name Run npm run deploy to deploy to your firebase project

Prerequisites

You need the Firebase CLI, and to log in to it.

Installing

Clone
Run npm i
Profit

Running the tests

No Test yet, they're on the way.....I promise.

And coding style tests

Basic ES Lint running. It will tell you things to change. It's your choice to follow them.

Deployment

Run npm run deploy

Built With

Contributing

Make a PR if you think you have something to add.

Versioning

What's that?

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

I would like to acknowledge that I read some things to do this. I forget what they were, but googling will help if you're curious I bet.