Skip to content

Latest commit

 

History

History
executable file
·
39 lines (27 loc) · 2.1 KB

README.md

File metadata and controls

executable file
·
39 lines (27 loc) · 2.1 KB
Raw

Udagram REST API

Udagram is a simple cloud application developed alongside the Udacity Cloud Engineering Nanodegree. It allows users to register and log into a web client, post photos to the feed, and process photos using an image filtering microservice.

The project is split into three parts:

  1. The Simple Frontend A basic Ionic client web application which consumes the RestAPI Backend.
  2. The RestAPI Backend, a Node-Express server which can be deployed to a cloud service.
  3. The Image Filtering Microservice, the final project for the course. It is a Node-Express application which runs a simple script to process images.

Getting Setup

Installing project dependencies

This project uses NPM to manage software dependencies. NPM Relies on the package.json file located in the root of this repository. After cloning, open your terminal and run:

npm install

tip: npm i is shorthand for npm install

Installing useful tools

1. Postbird

Postbird is a useful client GUI (graphical user interface) to interact with our provisioned Postgres database. We can establish a remote connection and complete actions like viewing data and changing schema (tables, columns, ect).

2. Postman

Postman is a useful tool to issue and save requests. Postman can create GET, PUT, POST, etc. requests complete with bodies. It can also be used to test endpoints automatically. We've included a collection (./udacity-c2-restapi.postman_collection.json ) which contains example requsts.

Running the Server Locally

To run the server locally in developer mode, open terminal and run:

npm run dev

Developer mode runs off the TypeScript source. Any saves will reset the server and run the latest version of the codebase.