Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 4.86 KB

README.md

File metadata and controls

65 lines (51 loc) · 4.86 KB
Raw

Project3-Refactor Udagram app into Microservices and Deploy

This repository is associated with Cloud Developer ND - Course 03 - Monolith to Microservices.

About the Project - Udagram Image Filtering Microservice

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. Following are the services involved in this project:

  • “user” - allows users to register and log into a web client,
  • “feed” - allows users to post photos, and process photos using image filtering
  • “frontend” - acts as an interface between the user and the backend-services
  • "reverseproxy" - For resolving multiple services running on same port in separate containers

Correspondingly, the project is split into following parts:

  1. The RestAPI Feed Backend, a Node-Express feed microservice.
  2. The RestAPI User Backend, a Node-Express user microservice.
  3. The Simple Frontend - A basic Ionic client web application which consumes the RestAPI Backend.
  4. Nginx as a reverse-proxy server, when different backend services are running on the same port, then a reverse proxy server directs client requests to the appropriate backend server and retrieves resources on behalf of the client.

Clone the project GitHub repository

Create a project folder in your local computer and clone the following Git repository - https://github.com/udacity/nd990-c3-microservices-v1

Dependencies and Getting Setup

tip: this frontend is designed to work with the RestAPI backends. It is recommended you stand up the backend first, test using Postman, and then the frontend should integrate.

1. Installing Node and NPM

This project depends on Nodejs and Node Package Manager (NPM). Before continuing, you must download and install Node (NPM is included) from https://nodejs.com/en/download. Verify the installation of Node.js using following command in your "terminal" / "cmd":

node -v

Verify the installation of NPM and update:

npm -v
npm update

How to Install project dependencies using NPM

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

2. Installing Ionic Cli

The Ionic Command Line Interface is required to serve and build the frontend. Instructions for installing the CLI can be found in the Ionic Framework Docs. When we would configure and start the backend services, then the frontend server can be started using following command in the terminal:

ionic serve

3. AWS RDS - PostgreSQL instance, Postbird tool, and an S3 bucket

You'll need an AWS account to set up these resources. Create the PostgreSQL instance on AWS and install the Postbird tool to interact remotely with the database. Additionally, you'll need to create an S3 filestore bucket in AWS

4. Docker Desktop

Lesson 3 of this course would require you to install Docker Desktop to create containers for individual microservices. Refer the following links for instructions

5. Kubernetes

Lesson 4 of this course would require you to install any one tool for creating a Kubernetes cluster - KubeOne / Minikube / kubectl on top of Docker Desktop. Refer - Creation of Kubernetes Cluster

6. Travis CI

Lesson 6 of this course would require you to use Travis CI. You would have to sign-up on Travis-ci.com using your GitHub account credentials and then create a .travis.yml for your project. Refer this tutorial to get started with Travis CI.