Name		Name	Last commit message	Last commit date
parent directory ..
controllers		controllers
services		services
.gitignore		.gitignore
README.md		README.md
handler.ts		handler.ts
index.ts		index.ts
package-lock.json		package-lock.json
package.json		package.json
serverless.yml		serverless.yml
tsconfig.json		tsconfig.json

README.md

API

The API is built using Node.js and Express. It is hosted on an AWS EC2 instance.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

Node.js
npm

Installing

A step by step series of examples that tell you how to get a development environment running:

Clone the repo

git clone https://github.com/jtsang02/Spatial-App.git

Install NPM packages

npm install

Running the server

In the project directory, you can run:

npm start

This runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

Using the API

The API is (or occasionally will be) hosted on an AWS EC2 instance. The base URL is:

http://ec2-3-134-88-136.us-east-2.compute.amazonaws.com:3000/

Here are some example API calls:

POST a calculation: POST /calculate