Git Product home page Git Product logo

dnd-companion's Introduction

curse-of-strahd-companion

This project is an online extension of the player's handbook used in Dungeons and Dragons. Currently this project keeps track of player notes (friends, foes, and general info) and character information. The project uses firebase, with ember-fire, for authentication and database storage. The UI is designed with ember paper, and ember trix editor for input.

This README outlines the details of collaborating on this Ember application.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone <repository-url> this repository
  • cd curse-of-strahd-companion
  • npm install
  • Setting up Firebase
    • Sign up for a Firebase account
    • Create a new Firebase app from the Firebase Console
    • Enable Authentication
      • Under the Develop Section select Authentication
      • Click on the Sign-in Method
      • Click on the edit icon on the Google section
      • Enable Google Authentication
    • Enable Storage
      • Under the Develop Section select Database
      • Choose the Realtime Database option and click Get Started
      • Select Start in test mode and click enable
    • Set up local authentication
      • Find the gear in the top left next to Project Overview
      • Grab the Project ID and Web API Key you'll need those for your Firebase environment variables

Running / Development

FIREBASE_API_KEY="your_firebase_api_key" FIREBASE_PROJECT_ID="your_firebase_project_id" npm run start

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

  • ember test
  • ember test --server

Building

  • ember build (development)
  • ember build --environment production (production)

dnd-companion's People

Contributors

ember-tomster avatar pepke41 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.