Skip to content

Latest commit

 

History

History
184 lines (142 loc) · 5.13 KB

README.md

File metadata and controls

184 lines (142 loc) · 5.13 KB

Contributors Forks Stargazers Issues


Logo

Pray the dice

A web tabletop app for roleplaying games.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact

About The Project

Beyond desktop

This project is a digital version of Aria's role-playing game from Games of roles. The project aims to allow everyone to play where and when they want, on desktop or mobile. Create your campaign your characters and play.

Built With

The application is on the React framework thanks to the service of Firebase

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Create a project on Firebase
  2. Get the Firebase config and create a .env file on the root
REACT_APP_API_KEY=""
REACT_APP_AUTHDOMAIN=""
REACT_APP_PROJECT_ID=""
REACT_APP_STORAGEBUCKET=""
REACT_APP_MESSAGING_SENDER_ID=""
REACT_APP_APP_ID=""
REACT_APP_MEASUREMENT_ID=""
REACT_APP_DATABASE=""
  1. Activate the Firebase auth configuration for google on "Sign-in method"
  2. Change the rules of Cloud Firestore for :
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth.uid != null;
    }
  }
}
  1. Change the rules of Real Time Database for :
{
  "rules": {
    ".read": "auth != null",
    ".write": "auth != null"
  }
}

Installation

  1. Clone the repo 
    git clone https://github.com/Qboussard/Pray-the-dice.git
  2. Install NPM packages 
    yarn install

Start and use

Start the server

yarn start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Praythedice - @Gaviil_ Project Link: https://github.com/Qboussard/Pray-the-dice