Skip to content

Deployment-Info.md

Latest commit

 

History

History
42 lines (30 loc) · 2.04 KB

Deployment-Info.md

File metadata and controls

42 lines (30 loc) · 2.04 KB

Pathways Website Deployment Documentation

Table of Contents

  1. Overview
  2. Architecture
  3. Deployment Environment
  4. Dependencies
  5. Deployment Process
  6. Configuration
  7. Backup and Recovery

Overview

A project to let employers search for T-Level programs. For more detail look here

Architecture

This website has a react frontend and a Express backend. Data comes from the The Institute for Apprenticeships and Technical Education's occupational maps API more info here

Deployment Environment

Dependencies

  • Frontend Framework: React 18.3.1
  • Backend Framework: Express 4.19.2

Deployment Process

Push to dev or main and github should automatically deploy. If you encounter problems look on Netlify or Render for error messages related to the deployment

Configuration

  • Environment Variables: Frontend REACT_APP_SERVER gives the frontend the address for the backend Backend API_KEY the key for accessing the occupational maps API can be requested here, BASE_URL the part of the URL use in all calls to the occupational maps API, PORT what port to use if running locally, FRONTEND the address for the frontend.
  • Config Files: Backend and Frontend have package.json for managing extensions and libraries. The frontend also has the Cypress config file.

Backup and Recovery

  • Backup Schedule: Back up was created at handoff
  • Backup Location: Rollback Branch
  • Recovery Process: Replace Dev or Main Branch with Rollback Branch and the product will work in the state it was handed off in.

Last Updated: 2024-08-28