Home

Welcome to the JaMmusic wiki!

Herein will be your comprehensive guide to getting started with setting up the front end and back end for Web Jam products. As well, we'll delve into setting your development environment in general.

Please note that this guide will be based on the assumption that you're using a Linux based system. While you can still set up everything on Mac or Windows, we won't be covering that in this wiki.

Check out our Getting Started write-up if you want a quick how-to on running our projects.

Table of Contents

• Home
  • 1. Introduction
  • 2. Web App Overview
    • 2.1 Product Perspectives
    • 2.2 Technologies
  • 3. Developer Prerequisites
    • 3.1 Ubuntu
      • 3.1.1 Remove the prompt for password
      • 3.1.2 Update Ubuntu OS (patches) and other installed software (do this often)
    • 3.2 GitHub Account
    • 3.3 Install Programs onto Ubuntu
      • 3.3.1 Curl
      • 3.3.2 NodeJS
        • 3.3.2.1 Updating NodeJS Version
      • 3.3.3 Git
      • 3.3.4 Yarn
      • 3.3.5 Atom
        • 3.3.5.1 Update the Atom Keybindings (keyboard shortcuts)
      • 3.3.6 KeePass
      • 3.3.7 Teamviewer
      • 3.3.8 Chrome
      • 3.3.9 Dropbox local sync to transfer files
      • 3.3.10 Create a Snapshot of your Virtualbox VM
    • 3.4 Local Git, GitHub, and Zenhub
  • 4. Running the App Locally
    • 4.1 Running Ubuntu from Virtualbox
      • 4.1.1 Update your Ubuntu
        • 4.1.1.1 If Unity Menu Disappears after an Update
    • 4.2 Get the Front-end Running on localhost
      • 4.2.1 IF you do not have any code at all…
        • 4.2.1.1 The .env file
      • 4.2.2 IF you already have code and need to get the latest…
      • 4.2.3 Now that you have the latest code, check for node version.
    • 4.3 Get the Backend Running on Localhost
      • 4.3.1 IF you do not have any back-end code at all…
        • 4.3.1.1 The Backend .env Files
      • 4.3.2 IF you already have code and need to get the latest…
    • 4.4 Check for Node Version and install Packages
  • 5. Developing the Frontend or Backend Codebase
    • 5.1 Be on Your Branch and Up-to-date
    • 5.2 Make changes to the code
    • 5.3 Push code from your local branch to your branch in github.com
      • 5.3.1 After Submitting Your Changes
  • 6. Chrome Console and Inspect
  • 7. Software Testing
    • 7.1 Testing Frameworks
    • 7.2 Static Tests
    • 7.3 Unit Tests
      • 7.3.1 Unit Test Coverage Reports
      • 7.3.2 Backend Unit Testing
        • 7.3.2.1 Mocha
        • 7.3.2.2 Run a Single Mocha Test
      • 7.3.3 Frontend Unit Testing
        • 7.3.3.1 Debugging the Karma Unit Tests
        • 7.3.3.2 Run A Single Karma Test (f = focus)
        • 7.3.3.3 Karma / Jasmine Runs Timers and setInterval
        • 7.3.3.4 Frontend Combined Coverage Reports
    • 7.4 Integration Tests
    • 7.5 Circle CI - Continuous Integration Test Server
      • 7.5.1 View the code coverage in CircleCi
      • 7.5.2 Project Stops Building
      • 7.5.3 Project Builds with Errors
  • 8. Working with Heroku
    • 8.1 Heroku Web Interface
    • 8.2 Heroku Command Line Interface (CLI)
      • 8.2.1 Installation
      • 8.2.2 Login
      • 8.2.3 View apps
      • 8.2.4 View logs
      • 8.2.5 Configure app settings
  • 9. Working on the Web Jam Backend Repo
    • 9.1 NodeJS and Express
    • 9.2 Working with MongoDB
      • 9.2.1 mLAB
      • 9.2.2 MongoDB at Localhost
  • 10. Guidelines for New Developers
    • 10.1 GitHub and Code Review (Pull Request)
      • 10.1.1 Linked Issues to Pull Requests
    • 10.2 Pair Programming
    • 10.3 Unit Testing
    • 10.4 Scrum and ZenHub Task Board
    • 10.5 Tech Stack
    • 10.6 Communication
    • 10.7 Payment Method
  • 11. Appendix
    • 11.1 wj-common-front
    • 11.2 React
      • 11.2.1 React Render
      • 11.2.2 React Project Files and Folders
    • 11.3 Code Climate Locally
    • 11.4 Cell Phone Screen Sizes
    • 11.5 CORS Errors
• Frequently Asked Questions