Collaboration

The following Slack channels can be used to communicate with the rest of the team:

Software Tools

You should install and familiarize yourself with our front-end tools:

  • git is used for version control. First, get it running locally and generate a new SSH key

  • GitHub is also necessary, and you won’t be able to clone the ux-platform repository until you authorize your SSH key with Banno

  • npm (included with Node) or Yarn is used for managing 3rd-party software packages

    You must also configure npm to use our internal registry for @banno packages.

    Because of the way that OSX and other tools like Homebrew and XCode modify the system, we recommend using a Node version manager like nvm or n to install Node+npm. For example:

    nvm install stable
    nvm alias default stable
    nvm use default
    
  • Some npm modules that may be useful tools: http-console, http-server, notes, npm-check

  • yarn works alongside npm, and we often use it instead of npm to add and remove packages to our projects. Prior to running yarn make sure your VPN is turned off and you’re added to your Artifactory group, for which you can submit a request in #org-ground-control

  • The LiveReload Chrome plugin auto-refreshes the webpage when you make changes to the code

  • bower is another package manager, built on top of npm. DEPRECATED: bower is no longer used

  • gulp or grunt is used for automating development tasks. DEPRECATED: We’re moving away from grunt/gulp to npm scripts

Banno Online

  • The online team should follow these instructions when creating your npmrc file
  • When using yarn you might run into errors if using the latest version of node. If this happens try using an earlier version of node, such as v14
  • The following VSCode extentions can be helpful for navigating the codebase: Auto Rename Tag, es6-string-css, es6-string-html, ESLint, file-icons, Git History, GitLens - Git supercharged, OpenAPI (Swagger) Editor, OpenAPI Preview, YAML, lit-plugin, and polymer syntax

Other tools that are useful