/skunk-2018

MongoDB Skunkworks 2018

Primary LanguageJavaScript

<Your Hackathon Here>.js

A generic Hackathon infrastructure ready to deploy.

Goals

  1. Make a single configurable tool to act as hackathon infrastructure to stop repetitive coding of the same app by every hackathon in existance.
  2. Be simple to use and configure so that everyone can have ther own app.
  3. Easy to run, low deployment cost.

How-To...

Deploy

  1. Create a MongoDB Atlas account.
  2. Create a free-tier tier cluster.
  3. Create a stitch application and link it to your new cluster.
  4. Fork this github repo.
    1. Clone locally.
    2. npm install
  5. Edit the variables and files in the config folder.
  6. Commit your changes
  7. npm run deploy
  8. In your fork on github, under settings, turn on github pages.
  9. Point your DNS at this page with a CNAME entry.

After the first deploy you can just edit config and re-run the deploy script

Deploy Locally

  1. npm install
  2. npm run dev
  3. Open localhost:8080

Configure

Overwrite the content in the config directory and it will be applied to your app. Static content can be written in either Markdown or HTML.

Runtime variables can be set per environment via the appropriate <env>.json file in ./config/. See the schema in ./config/config_schema.json for how each variable should be set.

Stack

This Aurelia application runs on MongoDB Atlas with Stitch.