The project application, Udagram - an Image Filtering application, allows users to register and log into a web client, post photos to the feed, and process photos using an image filtering service. It has two components:
- Frontend - Angular web application built with Ionic framework
- Backend RESTful API - Node-Typescript application
- Node v14.15.1 (LTS) or more recent. While older versions can work it is advisable to keep node to latest LTS version
- npm 6.14.8 (LTS) or more recent, Yarn can work but was not tested for this project
- AWS CLI v2, v1 can work but was not tested for this project
- A RDS database running Postgres.
- A S3 bucket for hosting uploaded pictures.
Provision the necessary AWS services needed for running the application:
- In AWS, provision a publicly available RDS database running Postgres.
- In AWS, provision a s3 bucket for hosting the uploaded files.
- Export the ENV variables needed or use a package like dotnev/.
- From the root of the repo, navigate udagram-api folder
cd starter/udagram-api
to install the node_modulesnpm install
. After installation is done start the api in dev mode withnpm run dev
. - Without closing the terminal in step 1, navigate to the udagram-frontend
cd starter/udagram-frontend
to install the node_modulesnpm install
. After installation is done start the api in dev mode withnpm run start
.
This project contains two different test suite: unit tests and End-To-End tests(e2e). Follow these steps to run the tests.
cd starter/udagram-frontend
npm run test
npm run e2e
There are no Unit test on the back-end
Unit tests are using the Jasmine Framework.
The e2e tests are using Protractor and Jasmine.