Web frontend on AgStack Documentation

Getting started

Mon, 01 Jan 0001 00:00:00 +0000

Running the INATrace web frontend against a local backend.

Requirements

Node 14.x. Later majors do not work: the Angular 10 development server stops at startup with An unhandled exception occurred: No such module: http_parser. Node 14 is past end of life, so install it next to your usual version with a version manager (nvm, asdf, volta) rather than system-wide.
Angular 10 comes from npm install; there is nothing to install separately, and the commands below use the project’s own CLI.
WebStorm or VS Code (recommended)
VS Code pluggins:
- Debugger for Chrome
- EditorConfig for VS Code
- npm support for VS Code
- HTML Format (from Mohamed)
- TSLint

How to run

Clone the repository

Using INATrace

Mon, 01 Jan 0001 00:00:00 +0000

What a user sees on the way in: the public welcome page, registration, and the home screen each company lands on.

Welcome page

This is the welcome page at inatrace.org . From here, existing users can login by clicking “Login” in the top right corner. New users can click on “Read more” button, where they can get more info on how to get registered.

Registration

New users must enter their name, surname, email and password. The terms and conditions have to be accepted. The submitted email address receives a confirmation link to confirm the email address. After confirming the email, a system admin must activate the account.

Products

Mon, 01 Jan 0001 00:00:00 +0000

A product is what a company sells and traces. This is where its details, its QR labels, the companies involved in making it, and the public-facing B2C page are configured.

Each company has its products, which are visible in the products tab which is opened by clicking the above icon.

Product settings

Each product can contain information like name, picture, origin, data about social responsibility, environmental sustainability, etc. This is defined in the “Product settings”.

Company operations

Mon, 01 Jan 0001 00:00:00 +0000

The day-to-day record of a cooperative: what came in from farmers, what was done to it, what was paid for it, and who the farmers are.

The currently active company is displayed when opening the company tab. “Deliveries” tab of “My stock” is opened by default.

Deliveries

Shows deliveries of semi-products from farmers and collectors. By selecting a facility, new deliveries can be recorded by clicking “Add delivery” or “Add bulk delivery”.

Dashboard

Mon, 01 Jan 0001 00:00:00 +0000

Deliveries and processing performance over a selected period, exportable to Excel, PDF or CSV.

The Dashboard contains a graphical representation of selected Company data. Currently, there is support for displaying the Deliveries for the selected time frame and displaying processing performance for the selected Processing action and time frame.

Deliveries

Processing performance

For every graphical representation section, the user can export the data for the selected parameters in either Excel, PDF or CSV format.

System settings

Mon, 01 Jan 0001 00:00:00 +0000

System-wide configuration, available to system administrators: companies, users, value chains, currencies and the type codebooks.

This section is dedicated to system settings. Settings are accessible by clicking the cog icon in the sidebar. This menu is only available for system administrators. Companies, users, value chains, currencies and settings are configured on these pages.

Companies

Here, new companies can be added and existing ones can be edited.

Users

This is the list of system users. To show all users, the “My users” filter needs to be deactivated. Users can be edited, activated, deactivated and promoted or demoted out of the System admin role. Users can also be set as a Regional admin, which can administer resources owned by the companies where the user is part of.

Building

Mon, 01 Jan 0001 00:00:00 +0000

Building and tagging a Docker image.

Builds are done using Docker with the build script located in Dockerfile.

To build, tag and push an image run docker-build.sh. See the file for a detailed command syntax.

To build and tag an image localy with name inatrace-be and version 2.4.0 run:

./docker-build.sh inatrace-be 2.4.0

To build and tag an image with name inatrace-be, version 2.4.0 and push it to a remote Docker registry my-docker-registry run: