Daily - theRAPTLab/gsgo GitHub Wiki

Daily Operations with GEM-STEP

This presumes you have successfully installed and initialized the development environment.

1. Running GEM-STEP

GEM-STEP is a collection of code packages in a single Git repository.

Generally, to run a particular package, you use the npm run command in Terminal from the 'gsgo' directory. Substitute the location of your local repo for ~/projects/gsgo in the following instructions.

After first time install

The install-helper.sh script you ran as part of the initial install should have loaded all necessary npm modules and run the bootstrap script.

To run the full system:

  1. cd ~/projects/gsgo
  2. npm start
  3. CTRL-C to stop system.

EXPERT USERS: Run a particular system by name

npm run <subsystem> Use CTRL-C to stop system. Valid subsystem names are listed using npm run list (e.g. 'gem'). See also npm scripts for more information about the custom npm scripts.

2. Update GEM-STEP to latest code

We release frequent updates to GEM-STEP throughout the project cycle. To make sure your version is up to date, you will have to pull the latest code changes from our source code repository.

  1. git pull
  2. npm run bootstrap
  3. Afterwards use the npm start or npm run <subsystem> command to run per usual.

You may be prompted to enter a password after git pull. This is your GitLab password.

3. Test a Development Branch

We also release alternative development versions of the software in "branches", often in response to one of your requests. In these situations, you'll need to run the following commands:

  1. git fetch to get the latest repo info
  2. git checkout <branch> to check out the branch, e.g. git checkout user-login for the user-login branch.
  3. npm run bootstrap to install all dependencies.
  4. Then run the system with npm start or npm run <subsystem>.
  5. Use CTRL-C to stop the system.

After you checkout a branch, you'll probably want to switch back to the "master release" branch which is named master. git checkout master npm run bootstrap

TIPS

  • If you are not sure what branch you are currently on, use the git status command.
  • If you have accidentally edited any files, changing branches may not be possible because Git wants you to save them. You probably DON'T want to save them back to the repo, as this would disrupt our development workflow. Use the command git reset --hard HEAD to restore the current branch to the way it was, which will lose all your changes.
⚠️ **GitHub.com Fallback** ⚠️