Project Portal Documentation 1 Help

Home

Welcome to the EPR Project Portal Documentation.

Project Goals

  1. Improve the client experience by incorporating a web-based, interactive element into project outcomes

  2. Offer clients a web-based and interactive platform to view completed projects and projects in progress

Modules

  1. Client Portal: Each project will be presented to the client through a custom set of interactive (maps, charts, etc.), web maps being the most prominent. Maps currently provided in paper format in the appendices of project deliverables will be transformed into interactive web maps providing clients with innovative methods to delve into deliverables.

  2. Contractor Bidding: A web-based dashboard for subcontractors to bid on specific project tasks offered by EPR.

Table of Contents

  • Security: Information about Authorization and Authentication procedures and policies

  • Semantics: Topics related to terminology in the project portal


    • Classes: Information regarding the top level concepts called classes

    • Glossary: General terms with definitions used throughout the application and documentation

    • Data Dictionary: The class-level controlled vocabularies used in the project portal

  • Business Rules: Set of rules and conventions that govern the mechanics of the project portal

  • User Flows:

  • How-to Guide: A collection of procedural instructions to assist users with performing major tasks

  • Technical

    • Database Documentation: Documentation that describes the backend relational PostgreSQL database

    • Hardware Specification: Profiles of the local, staging, and production server environments

    • Portal API Specification = Documentation on how to use the RestFUL API built into the project portal

    • Reference Datasets: Third-party datasets that serve as references

    • Technology Stacks: The technologies that the project portal is built upon

    • UI Specifications: Specification of the standardized parts of the user interface

    • UUIDs: Usage of Globally Unique Identifiers

Last Updated: 20250126

Last modified: 27 January 2025