Boardgame Manager

Epicodus Project in Angular, November 3, 2017

By Kelsey Langlois

Description

This is an app to help manage regular boardgame nights. It stores information about players' preferences and schedules, so that event organizers can pick the best day for a given game night. It also stores event listings, so that players can find game nights that match their interests.

Setup/Installation Requirements

• Clone this repository from: github.com/MacKLess/indiegofundstart.
• In order to run this app, you will need to set up a Firebase Database:
  • First, make a free Firebase account here.
  • Then, create a project from the Firebase console.
  • Create a file in the project directory at src/app/api-keys.ts.
  • Once the Firebase project is created, select "Add Firebase to your web app."
    • Copy the information from the pop-up window into api-keys.ts as follows:

    export var masterFirebaseConfig = {
      apiKey: "xxxx",
      authDomain: "xxxx.firebaseapp.com",
      databaseURL: "https://xxxx.firebaseio.com",
      storageBucket: "xxxx.appspot.com",
      messagingSenderId: "xxxx"
    };

  • Ensure that /src/app/api-keys.ts is included in your .gitignore file.
  • Return to the Firebase console and select your database, then select "Database" from the left-hand navbar.
  • Select the "Rules" option from the blue navbar near the top of the page.
  • Change both the ".read" and ".write" properties to "true".
  • To upload a starter set of events and players:
    • Find your project in the Firebase console.
    • Select the "Database" option from the left navbar.
    • Select the 3 dots on the right of the grey bar with the database url.
    • From that menu, select "Import JSON".
    • Upload database-starter.json from the project root directory.
• Make sure you have Node.js installed. Instructions for doing so can be found here.
• From the project root directory, run the following commands in the terminal:

  npm install
  bower install
  ng serve
  

• You can now open the site in your web browser at localhost:4200.

Specifications

• Player record stores name, favorite game, preferred game types, and schedule.
• Users can add, edit, and delete players.
• Event record stores event name, location, date, and game types.
• Users can add, edit, and delete events.
• When creating an event, app provides suggested days based on the game types planned.

Support and contact details

Please contact [email protected] with questions, comments, or issues.

Technologies Used

• JavaScript
• TypeScript
• Node.js
• Angular
• Bootstrap
• Firebase

This project was generated with Angular CLI version 1.0.0. To get help on the Angular CLI use ng help or go check out the Angular CLI README.

License

Copyright (c) 2017 Kelsey Langlois

This software is licensed under the MIT license.