Skip to content
Snippets Groups Projects
README.md 1.38 KiB
Newer Older
  • Learn to ignore specific revisions
  • Grace Copplestone (admin)'s avatar
    Grace Copplestone (admin) committed
    # Install and run mods
    
    
    You need to first install [node.js](https://docs.npmjs.com/getting-started/installing-node).
    
    Install the [http-server](https://www.npmjs.com/package/http-server) npm package. Including '-g' sets the installs the package gloabally, allowing you to use it as a command line tool:
    
    <code>npm install http-server -g</code>
    
    Clone the mods repository:
    
    <code>git clone ssh://git@gitlab.cba.mit.edu:846/pub/mods.git</code>
    
    Use the command line to navigate to the root of the mods repository:
    
    <code>cd mods</code>
    
    Start up a server:
    
    <code>http-server</code>
    
    Open a browser tab and go to <code>127.0.0.1:8080</code> which is the same as <code>http://localhost:8080</code> to view the server that you just started.
    
    Depending on how to need to use mods you can start local servers located in <code>mods/js</code>, for example, if you start from the root of the mods repository:
    
    <code>cd js</code>
    
    <code>node printserver.js</code>
    
    Amanda Ghassaei's avatar
    Amanda Ghassaei committed
    #Mods Connection Debugging
    
    Neil Gershenfeld's avatar
    Neil Gershenfeld committed
    
    
    Amanda Ghassaei's avatar
    Amanda Ghassaei committed
    set correct serial port permission (do this each time you reboot the machine): <code>chmod a+rwx /dev/ttyUSB0</code>
    
    Neil Gershenfeld's avatar
    Neil Gershenfeld committed
    
    
    Amanda Ghassaei's avatar
    Amanda Ghassaei committed
    start serialserver in the terminal so you can see the logs as it tries to connect.
    
    Amanda Ghassaei's avatar
    Amanda Ghassaei committed
    
    navigate to the mods/js folder in the terminal (probably use <code>cd ~/mods/js</code>) and type: <code>node serialserver.js ::ffff:127.0.0.1 1234</code>
    
    Amanda Ghassaei's avatar
    Amanda Ghassaei committed
    
    check serialserver is running with: <code>ps aux | grep node</code>
    
    Neil Gershenfeld's avatar
    Neil Gershenfeld committed