/codam-marauders-map

Primary LanguageJavaScriptMIT LicenseMIT

Codam Marauder's Map

A very reasonable (and early alpha) map for the codam clusters

Setup

  1. Request API keys for the intranet. The redirect URI should be http://localhost:3000/auth/callback and we only need the "Access the user public data" scope.

  2. Store the UID and SECRET in a .env file at the root of the repository:

    UID=your_uid_here
SECRET=your_secret_here

  3. Install Node.js and Redis

    If you are on a Codam iMac you can install them using homebrew:

    1. Install 42 Homebrew: 
      curl -fsSL https://rawgit.com/kube/42homebrew/master/install.sh | zsh
    2. Install Node.js and Redis: 
      brew install node redis

  4. Install dependencies using npm i

Running locally

  1. Start redis using redis-server
  2. Run the project using npm run dev in a separate terminal. (hint: press ⌘\ to split the terminal in vscode)
  3. Visit https://localhost:3000 🎉 (if it doesn't work, ask nloomans or nmartins)