Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 3.72 KB

README.md

File metadata and controls

97 lines (78 loc) · 3.72 KB
Raw

BJJ Analytics

React web app that uses Highcharts to display useful metrics and graphs, using endpoints from Google Calendar Analytics to get the data.

Demo

The production version is live at www.azizj1.com. Dev version is at dev.azizj1.com.

Getting Started

This repo is a client for the analytics API, so it necessitates a couple of prerequisites.

Prerequisites

  • At least npm. Preferrably yarn installed globally (npm i yarn -g) in light of the yarn.lock file.
  • The analytics API server locally up and running.

Developing

Install all project dependencies

yarn

Run server

cd ../google-calendar-analytics && yarn && yarn start && cd ../bjj-analytics

Kick off watcher with hot-reload

yarn start

To analyze webpack bundle and dependencies, run

yarn analyze

Deployment

The website is deployed to dev.azizj1.com and azizj1.com using GitHub Pages.

Prerequisites

Setup GitHub Pages:

  1. Create two additional GitHub repos: one for dev/qa environment and another for prod.

  2. Enable GitHub Pages through repo settings, making sure Source is set to master branch.

  3. Update ./package.json scripts (scripts.deploy and scripts.deploy-prod) with your repo URLs.

  4. Configure your custom domain's DNS to route to Github Pages.

    Example of DNS

    Note: If your DNS is managed by Route53, you have profile aws-cli setup so it can at least query Route53 zones, create Route53 records, and write to S3 (terraform state file. If you don't want to use a remote state file, comment out terraform { ...} in ./terraform/config.tf) run

    yarn custom-domain

    on macOS, or

    yarn custom-domain-win

    for Windows.

    It'll prompt you for

    1. The S3 bucket to store the state file (if you decided to use remote state files),
    2. Your domain name (e.g., azizj1.com, google.com, etc.). You must have a Route53 zone already created for this domain, and update your domain's nameservers to the zone's nameservers.

  5. Update ./cnames.js with your custom domain.

Server setup:

  1. Deploy analytics API to dev/prod.
  2. Update ./endpoint.js with your base URLs for the respective environments.

Dev Environment

yarn deploy

Prod Environment

yarn deploy-prod

License

MIT License

Copyright (c) 2018 Aziz Javed

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.