Skip to content

Latest commit

 

History

History
345 lines (275 loc) · 10.6 KB

README.md

File metadata and controls

345 lines (275 loc) · 10.6 KB
Raw

Build Status Code Coverage Code Grade

tradeshow

Tradeshow Floorplan Manager

This is a blazingly fast static site built upon stable modern technologies like React and Firebase with a goal to simplify the trade show management process.

Specifically, it helps marketers/sales people consolidate their efforts and collaborate in real time with speed.

Rather than track everything by paper, you can use this web app to keep track of all booths you are managing and color code them according to who is managing the booth.

Table of Contents

Features

  • 🚀 Gatsby Static Site Generator for Blazingly Fast Performance & SEO.
  • 🔩 Socket.io for live updating between users.
  • 👀 react as the view.
  • 🔀 react-router as the router.
  • 🏪 redux as the central store for state management.
  • 💅 Styled Components as the styling library.
  • 🔥 Firebase DB as the database.
  • 👥 Firebase Auth for secure user authentication.
  • 💎 Firebase Functions to provide serverless architecture.
  • 📁 Firebase Storage for on-demand backups.
  • 🔄 Fast development hot reloading with react-hot-loader.
  • 👮 Security with Snyk and react-helmet.
  • 📦 All source is bundled using Webpack and Gatsby.
  • 👼 ESlint Airbnb configuration for code quality.
  • 🌈 Prettier for beautiful auto code formatting.
  • 🎭 Jest as the testing framework to ensure reliability.
  • ❤️ Continuous integration with Travis-CI.
  • 🎯 ES6 Javascript for terse readable code.

Prerequisites:

  1. Nodejs & NPM
  2. Firebase
  3. Firebase tools

Setup

Available Scripts

  • Scripts are available in the package.json file at the root level under the "scripts" property
Development Mode
npm run dev
Production Mode
npm run build
npm run deploy

Changing Booth Layouts in Firebase

  • Booth locations are computed based on row, column and size which defaults to 1x1
  • Accepts an image url as the image key which will center & resize the custom image over the booth
  • Accepts a custom size key which can be specified as 3x2 or whatever
  • Firebase is NoSQL so if a key is not required, you don't have to specify it

Booth API

Option Usage Type
_id Required String
col Required Number
row Required Number
company Optional String
description Optional String
image Optional Url
num Optional Number
owner Optional String
size Optional String
status Optional String

Example:

"yourroute": {
  "630": {
    "_id":"5910ae25529a13a5bf988a5e",
    "num":630,
    "row":1,
    "col":13,
    "owner":"Ryan",
    "status":"holding",
    "company":"Cool Company",
    "description":"The most ultra cool co in existence!"
  },
  "531": {  
    "_id":"5910b02a529a13a5bf988af7",
    "num":531,
    "row":-1,
    "col":12,
    "owner":"None",
    "status":"good",
    "company":"Another cool co",
		"size":"2x1",
		"image":"urlToImage.com"
	},
	"randomthing": {
		"_id":"5910b02a529a13a5bf988af7",
    "row":10,
    "col":14,
		"size":"5x10",
		"image":"urlToImage.com"
	}
}
  • The second key under "yourroute" must be unique
    • One of the main reasons for it is convenience when trying to find a booth in the firebase console

How To Deploy Firebase Functions And App To Firebase Hosting

  • To Set up Firebase head to: https://console.firebase.google.com
    • Proceed through the instructions to set up a new project.
    • Once you have completed those steps successfully, you can set up each of these sections below:
  1. Make sure .firebaserc in the root of this project has your project id.
  2. With firebase-tools installed you can run firebase from the command line
firebase login
  • To get all your credentials
firebase setup:web
  • Create a new file called config.js in the root of this repo with the file below
    • Add the credentials the firebase setup:web command prints out under the key FIREBASE_CONFIG
    • This file is in .gitignore so will not be committed because it contains secrets
    • Make sure the first letter of the owner names are captalized in both firebase db and the config.js USER_MAP
const AUTHENTICATED_USER_EMAILS = [
	'[email protected]',
	'[email protected]',
	...
]

const BOOTH_LAYOUT = {
	borderWidth: 2,
	columns: 18,
	dimension: 60,
	rows: 26,
}

// Click around your console.firebase.google to gather these values
const FIREBASE_CONFIG = {
	apiKey: 'your api key',
	authDomain: 'tradeshow-floorplan.firebaseapp.com',
	databaseURL: 'https://tradeshow-floorplan.firebaseio.com/ ',
	projectId: 'tradeshow-floorplan',
	storageBucket: 'gs://tradeshow-floorplan.appspot.com',
}

/**
 * Allows you to create programmatic routes
 * You can pass a custom BOOTH_LAYOUT object for each page if you would like
 * https://www.gatsbyjs.org/docs/bound-action-creators/#createPage
 */
const FLOORPLAN_PAGES = [
	{
		name: 'Los Angeles',
		path: '/la',
		context: BOOTH_LAYOUT,
	},
	{
		name: 'Long Beach',
		path: '/lb',
		context: Object.assign({}, BOOTH_LAYOUT, { columns: 15, rows: 27 }),
	},
]

const USER_MAP = {
	Jin: {
		color: '#ff00aa',
		email: '[email protected]',
	},
	Richard: {
		color: '#0800FF',
		email: '[email protected]',
	},
	Todd: {
		color: '#00B20E',
		email: '[email protected]',
	},
}

module.exports = {
	AUTHENTICATED_USER_EMAILS,
	FIREBASE_CONFIG,
	FLOORPLAN_PAGES,
	USER_MAP,
}

Firebase Authentication:

  • Only google auth is currently set up as provider

    Firebase Auth

Firebase Database Rules:

Firebase DB Docs

{
  "rules": {
    ".read": true,
    ".write": "auth.token.email == '[email protected]' || auth.token.email == '[email protected]'"
  }
}

Firebase Storage Rules:

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read: if false;
      allow write: if request.auth.token.email == '[email protected]' || request.auth.token.email == '[email protected]';
    }
  }
}

Firebase Functions:

  • The only part of this app that would require a server is sending emails
  • However, thanks to Firebase Functions, we can still have a serverless web app that is blazingly fast
  • To run a local firebase shell:
npm run shell
  • You can then call the email function directly from there if you would like to test it out
emailTeam()
  • To only deploy functions rather than hosting run:
npm run deploy:functions
  • Otherwise you can just call the function from the web app and check the Firebase function logs: Firebase Logs

Setting Up The Emailing Feature

  • In the functions directory create a new file called emailConfig.js that has the content below
    • This file is in .gitignore
// functions/emailConfig.js
const GMAIL_SETTINGS = {
	email: '[email protected]',
	pass: 'password',
}

const RECIPIENT_EMAILS = [
	'[email protected]',
	'[email protected]',
	...
]

module.exports = {
	GMAIL_SETTINGS,
	RECIPIENT_EMAILS,
}

How On-demand Backups Work

  • On-demand backups store the firebase db in json format in firebase storage for easy retrieval
  • The backups are launched when user visits site
  • On-demand client side db backup max 1 backup per day

License

The MIT License (MIT)

Copyright (c) 2017 Ryan Garant

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.