Your application name

Your application brief description.

Applications wiki

Link to applications wiki

Main functionalities

• View product catalogue
• Add products to shopping cart
• Process payment of products
• Manage customer orders

Application Architecture

more information here

Technical information

Stack

This application uses the following technologies:

• React
• Redux
• NginX

Developer information

Requisites

To develop in this application you will need, at a minimum, to have installed in your system the following:

• Docker with Compose

Local development environment

This repository contains a local development environment, fully containerised, that can be used to run the application on your machine and test it.

The services available in the local development environment are configured at setup/local/docker-compose.yml and setup/local/docker-compose.elk.yml.
NOTE: Any service assigned with the profile only_if_not_cicd will not be started in a CICD environment.

NOTE: Use of a unix command line environment is recommended.

Run the local environment in development mode

To run the local environment, in development mode, follow these steps:

1. From the root of the project run the command

sh cli/start.sh [flags] [services]

Where:

flags:
Any flag supported by the Docker compose up command.
For more information consult the official Docker documentation.
NOTE: Consider using the -d flag, which runs the Docker project in detached mode.

services:
Whitespace separated list of services to run.
The available services are declared in the local environment Docker compose project at setup/local/docker-compose.yml.
NOTE: If no services are provided, all services will be started.

This will run a Docker compose project and start several networked Docker containers will all the services and necessary tools to use the application.

The following services will be running in the containers:

• List your services here

2. Interact with the local environment via the following URLs:

Application: http://localhost:10000

Run the local environment simulating the remote environment

To run the local environment, simulating a remote environment, follow these steps:

1. From the root of the project run the command

sh cli/start_nginx.sh [flags] [services]

Where:

flags:
Any flag supported by the Docker compose up command.
For more information consult the official Docker documentation.
NOTE: Consider using the -d flag, which runs the Docker project in detached mode.

services:
Whitespace separated list of services to run.
The available services are declared in the local environment Docker compose project at setup/local/docker-compose.nginx.yml.
NOTE: If no services are provided, all services will be started.

This will run a Docker compose project and start several networked Docker containers will all the services and necessary tools to use the application.

The following services will be running in the containers:

• NginX server

2. Interact with the local environment via the following URLs:

Application: http://localhost:10000

Stop the local environment

From the root of the project run the command

sh cli/stop.sh

This will stop the Docker compose project and cleanup its resources.

Configure the local environment

To configure some of the parameters of the local environment follow these steps:

1. Copy the file setup/local/.env.template to setup/local/.env
2. Fill in the parameters you want to overwrite and delete the ones you want to keep the defaults
3. Run the local environment

Testing the application

From the root of the project run the command

sh cli/test.sh [flags] [projects]

Where:

flags:

• -w: Run the tests in watch mode (Requires at least 1 project to be specified)
• --unit: Run only unit tests
• --integration: Run only integration tests
• --e2e: Run only end to end tests
• --docker: Run the tests in a Docker container
• --filter: Run only the tests that match the provided pattern (Ex: test/unit will run only the tests that are inside the this path)
• --coverage: Run the unit tests with coverage report

projects:
Whitespace separated list of test paths to run.

NOTES:

• When running the tests with the flags --docker or --cicd, the tests will run inside a Docker container that will be in the myapp_shared network.
• When running the script with the flags --integration or --e2e the flag --docker is assumed as well, which means the tests will run inside a Docker container.

Generating test coverage reports

To generate unit test coverage reports, including an HTML report, from the root of the project run the command

sh cli/coverage.sh [flags]

Where:

flags:

• --docker Build the coverage report in a Docker container

The HTML coverage report is located inside the directory ./coverageReport, which contains an index.html file.

Project dependencies update validations

To check for updates to the project dependencies and update them if needed, from the root of the project run the command

sh cli/dependencies_update.sh [flags]

Where:

flags:

• -u | --update: Update all outdated dependencies. You will be prompted for each one for confirmation before updating
• -y: Update all dependencies without prompting
• --docker Run the script inside a Docker container

If the update flag is not provided, the script will print the report with all the dependencies that are outdated, but will not update any of them.

Security & Compliance Notes

more information here

CI/CD

more information here