Home - theRAPTLab/gsgo GitHub Wiki

2023-06-24 UPDATE: NOTE that this wiki was ported from gitlab.com. As a result there are many broken links. Your best bet is to use the sidebar to view all pages.

NOTE: GitLab-originated "Merge Requests" are in the github repo as "Issues" labeled "gitlab merge request".

The GEM-STEP Foundation Wiki describes how to install, operate, and modify the system.

Main Sections

Note: Try clicking View All Pages on the right sidebar if you can't find something you thought was here.

Quick Start

  1. Technical Requirements -- Server is a Node application developed for Mac. Clients are Chrome browsers on Mac, Windows, iOS, Android. Other browsers may or may not work.
  2. Quick Start Fresh Install -- Manual install on a new Mac for 2023.
  3. Installation Overview -- Updated detailed installation guide for 2022. 1. README -- The README file covers first time installation and daily running.
  4. Contributor Introduction -- If you are planning on contributing code, please review this introduction.
  5. Report Bugs

Design

Running Dev Builds

[Updated 2021-10-20]

A handy reminder of the current state of the system and how to keep it running. Scripts change over time.

On a new install / or if libraries have changed
  1. git fetch && git checkout <branch>
  2. npm run bootstrap -- This will reset node_modules and run npm ci again.
  3. npm run start -- This will run npm run build and npm run gem
If the server has changed
  1. git fetch && git checkout <branch>
  2. npm run start -- This will run npm run build and npm run gem
Daily
  1. git fetch && git checkout <branch>
  2. npm run start -- This will run npm run build and npm run gem
To build and run gem manually
  1. npm run bootstrap -- This will reset node_modules and run npm ci again.
  2. npm run build -- You MUST run build again after bootstrap.
  3. npm run gem

For more information on npm scripts.

GitHub Wiki Editing Tips

  • Referencing pull requests: Use [#762](../pull/*), e.g #762
  • Referencing releases/tags: Use [v1.3.0](../../releases/tag/v1.3.0-final)
  • Referencing code files from wiki: Use [label](../blob/dev/*.js) e.g. ../blob/dev/README.md
  • GitHub's wiki (Gollum) allows for organizing wiki files by folder, but pages are referenced as via a flat strucuture. e.g. you can save a file at /Developer/Introduction, but when referencing it, you need to use [Developer Introduction](Introduction). Also, all pages must have unique names, e.g. you can't have a /User/Introduction and /Developer/Introduction page. Instead, use /User/User-Introduction and /Developer/Developer-Introduction. Note that many gitlab-originated links need to be fixed to address this.
    • Quick Ref
      1. Get rid of nested folders: Developer [Introduction]('/Developer/Introduction') => Developer [Introduction]('Introduction')
      2. Make page names unique: User [Introduction]('Introduction') => User [Introduction]('/User-Introduction')
⚠️ **GitHub.com Fallback** ⚠️