Use CrinGraph as main

This layout keeps CrinGraph at the domain root as the front page and serves modernGraphTool from a subfolder. Both read the same data/ folder. See Dual-Hosting with CrinGraph for the other layout.

Step-by-Step Guide

1. Prepare Your Projects

• modernGraphTool: Set up the modernGraphTool database and files as described in the Guide for Operators.
• CrinGraph: Prepare the CrinGraph project files. You can use any variant of CrinGraphs.

2. Organize Your Directory Structure

Your root folder should contain the main index.html for CrinGraph.

Create a new folder (e.g., mGT) inside the root directory, and place all modernGraphTool files there.

The mGT folder should also have its own index.html.

Tip

CrinGraph was originally designed to contain measurement and target data in the same data folder. But, we’re going to separate these into a dedicated folder for each of them to make it easier to maintain.

Example structure:

/project-root/
├── data
|   ├── phones          # 'phone' measurements folder
|   |   ├── A8 L.txt      # measurement data
|   |   └── A8 R.txt      # measurement data
|   ├── target          # 'target' measurements folder
|   |   └── Target.txt    # target data
|   └── phone_book.json # List of phones
├── index.html          # CrinGraph entry point
├── ...other CrinGraph files...
└── mGT
    ├── index.html      # modernGraphTool entry point
    └── ...other modernGraphTool files...

3. Required Changes to CrinGraph

Since we are separating measurement and target data into a dedicated folder, we have to modify graphtool.js to properly fetch data from new directories.

The following examples are based on the squiglink/labs version of CrinGraph.

Tip

Even if you are using a different version of CrinGraph, you should be able to follow the examples below without any problems. However, there may be slight differences in details such as line positions.

graphtool.js

Open graphtool.js and find the loadFiles function (near the bottom of the file). Edit it as follows:

// Previous
let l = (f) => d3.text(DIR + f + '.txt').catch(() => null);
let f = p.isTarget
  ? [l(p.fileName)]
  : d3.merge(LR.map((s) => sampnums.map((n) => l(p.fileName + ' ' + s + n))));

// After
// If you're using custom directory for measurements, change the 'phones' and 'target' words to yours.
let l = (f) => d3.text(DIR + 'phones/' + f + '.txt').catch(() => null);
let lt = (f) => d3.text(DIR + 'target/' + f + '.txt').catch(() => null);
let f = p.isTarget
  ? [lt(p.fileName)]
  : d3.merge(LR.map((s) => sampnums.map((n) => l(p.fileName + ' ' + s + n))));

4. Required Changes to modernGraphTool

Since we don’t want to manage 2 data folders for each graphtool respectively, We need to update mGT’s config.js file to correctly fetch data from parent directory.

config.js

Find the PATH block in config.js and point each entry at the parent directory:

// Previous
PATH: {
  PHONE_MEASUREMENT: "./data/phones",
  TARGET_MEASUREMENT: "./data/target",
  PHONE_BOOK: "./data/phone_book.json",
},

// After
// If you're using custom directory for measurements, change the 'phones' and 'target' words to yours.
PATH: {
  PHONE_MEASUREMENT: "../data/phones",
  TARGET_MEASUREMENT: "../data/target",
  PHONE_BOOK: "../data/phone_book.json",
},

Notice that the single dot has been replaced with two dots, indicating mGT to look for a parent directory.

CDN-mode installs: set BASE_PATH

If you installed modernGraphTool with the CDN deployment method (cdn-index.html renamed to index.html), you also need to set CDN_MODE.BASE_PATH in config.js to match the subfolder you placed mGT in. For the /mGT/ layout above:

CDN_MODE: {
  MAJOR_VERSION: 2,
  BASE_PATH: "/mGT",
},

Without this, the mGT home page will load but share links will 404. See Why BASE_PATH is almost always required for the full explanation. This step is not needed for Pre-built Release installs.

5. Add Navigation Buttons to Each Tool

After finishing the code-weaving job above, you should be able to access 2 graphtools via these domains.

• To access CrinGraph: https://yourdomain.com/
• To access modernGraphTool: https://yourdomain.com/mGT/ (Folder name as subdomain)

We can add little buttons so users can easily navigate between these two.

CrinGraph

Head over to line 250 of config.js for headerLinks array, and add these line:

headerLinks = [
  {
    name: 'Go to modernGraphTool',
    url: 'https://yourdomain.com/mGT'
  },
  // or
  {
    name: 'Go to modernGraphTool',
    url: './mGT'
  }
];

modernGraphTool

Find the TOPBAR block in config.js and add a LINK_LIST entry. LINK_LIST is an array of { TITLE, URL } objects — you can add more entries later if you want extra navigation buttons.

TOPBAR: {
  LINK_LIST: [
    { TITLE: "Go back to CrinGraph", URL: "https://yourdomain.com/" },
    // or, relative to the mGT subfolder:
    // { TITLE: "Go back to CrinGraph", URL: "../" },
  ],
}

6. Deploying

Upload your project to your web server, ensuring the folder structure is preserved.

Both tools should now be accessible as described above.

Tip

If you are applying these changes to your squig.link database, the changes might not be shown immediately due to cached files.

You can apply these changes immediately by refreshing the cache. Add ?cachebust to the end of your database address, then reload the page.

e.g) https://example.squig.link/?cachebust