Skip to main content Link Menu Expand (external link) Document Search Copy Copied

How to Dev With Us

**This page is a work in progress as we curate the best materials for new collabortors. **

Prerequisites

Setup Steps

  1. In top toolbar of VSCode, click Terminal > New Terminal
  2. Type node -v in Terminal. (Will likely generate error if you’ve never done this before).
  3. Type npm -v in Terminal. (Will likely generate error if you’ve never done this before).
  4. Download and Install Node & NPM and try Steps 1-3 again.

Installing Node & NPM

  • https://www.guru99.com/download-install-node-js.html
  • https://nodejs.org/en/download/

Continued Steps for Local Deployment

  1. Create a New Folder on your Computer where you’d like to store this code.
  2. In VSCode, go to File > Open Folder to begin working inside this Folder. You may be prompted to agree you “Trust the Authors.”
  3. Now in your Terminal, type git clone https://github.com/XHARBOR/ThePortFront-TMP.git
  4. You may be prompted to Download and Install the Command Line Developer Tools. Please follow those instructions.
  5. If you needed Step 8, please repeat Step 7.
  6. You should see Cloning into 'ThePortFront-TMP'... as it clones the Repository
  7. Now we can “Do the Thing!”

Go to the README page for the Git Repository at: https://github.com/XHARBOR/ThePortFront-TMP.git for more detailed instructions.

Note: Please do not deploy or commit changes to this README Repository to avoid confusing future users.

  1. Change Directory by typing cd ThePortFront-TMP
  2. Now type in Terminal npm install
  3. You will now need your own API Credentials to contribute your work to our database.

API Credentials

Our Technical Director Michael Morran is the Admin on Firebase (where your cues can be stored). You will need your own unique credentials to access and deploy changes to this site. Please contact Michael at theaterfestonline@gmail.com to request your own credentials.

  1. In your folder structure in VSCode, look under ThePortFront-TMP > src > base.js
  2. Look for appId: "aBUNchOFl3ttersAndNumbers",
  3. Add your API Key between the quotation marks
  4. Now you are ready to create and deploy cues locally on your computer.
  5. In Terminal, type npm run dev
  6. This should launch your default web browser to the webpage http://localhost:3000/

Mozilla Hubs Default

For additional resources, please see the standard Dev Overview for Mozilla Hubs.