Crawler WEB

This frontend application responds to the requeriments of crawling websites URLs and listing the links retrieved.

The app is developed in Angular 9 using socket.io for living communication with the api server. Also uses the redux pattern through ngrx libs.

This project was generated with Angular CLI version 9.1.8.

For testing, the project contains a first very simple configuration build in karma which will be extended in future releases.

Its already set for deployment as docker image. Check intructions above.

Demo

Demo application deployed on Firebase. Check out here: (https://crawlerwebapp-okppg.web.app/#/)

Install packages and globals

$ npm install

Development server

Run npm start for launching dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Angular: Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README

Running unit tests

Run ng test to execute the unit tests via Karma.

Environment configuration

Currenty only one configuration is enabled: demo. This configuration replace the default environment file with the environment.[cfg] file, both stored in environments/ folder. For deploying the webapp make sure you have configured correctly the config associated file (api base url, api path, etc.)

ng build --configuration=[cfg]

Docker

The description file .dockerfile is stored in docker/ folder. It describes the Docker image. This image uses an nginx server for static content delivery. This server's configuration is described in ./nginx.conf file located at the same folder.

Build Image:

Ensure to construct the Angular App with ng build --configuration=[cfg] $ docker build -t [tag_name] .

For example, a build for a demo environment would be: ng build --configuration=[demo] $ docker build -t tracker/web:0.0.1 -f docker/dockerfile .

Creating and running the container:

To run this image, a container must be created.

$ docker run -d --name [container_name] -p [host_port]:[container_port] [tag_name]

For the previous example, the final command would be:

$ docker run -d --name trackerweb -p 80:443 tracker/web:0.0.1

__

TO DO TASKS

Running end-to-end tests with Protractor

Pending

Review Lint configuration, adjust parameters and finally resolve Lint results advices

Pending

Add versioning build to streamline the process

Pending