Developer Guide

Overview

What is Pathfinder? Explain what this web-based application does.
Explain benefits of this project. What can developers earn out of this project? (Why do they need to use this?)

(Use the sidebar on the right to move to the section that you're looking for)

Tech Stack

Frontend

JavaScript, React

Backend

Sparkle, GraphDB, MongoDB

Getting Started

We use yarn for managing Node packages. Check that you have it with

yarn -v

If the command is invalid, install it with

npm install -g yarn

Clone the repository

git clone --depth=1 https://github.com/csse-uoft/Pathfinder

--depth=1 signifies that we only care about the most recent commits.

Setting up frontend

• First, move into the frontend folder and install dependencies by typing the following lines in the shell. (npm is also required)

cd Pathfinder/frontend
npm install -g yarn
yarn install

• Then, you can start frontend by typing,

yarn start

• To build frontend,

yarn build

• To serve built frontend,

npx serve -s ./build

This information can also be found in README.md in frontend folder.

Setting up backend

• To install dependencies, type the following lines in the shell.

cd ../backend
npm install -g yarn
yarn install

• You should have received .env file. Copy .env to ./backend/.env

.env includes credentials for mailing server.

• Also start GraphDB and MongoDB by,

 docker run -p 7200:7200 -d --name graphdb --restart unless-stopped -t ontotext/graphdb:10.0.2 --GDB_HEAP_SIZE=6G -Dgraphdb.workbench.maxUploadSize=2097152000

docker run --name mongo -p 27017:27017 --restart unless-stopped -d mongo:latest

• To start backend,

yarn start

• To allow Self-Signed Localhost certificate, in chrome, enable

chrome://flags/#allow-insecure-localhost

• Then reboot the chrome.

This information can also be found in README.md in backend folder.

App Functions

API Reference

---

Move back to Table of Contents