Social Care System Architecture

This site is a "central landing zone" to document and share the architecture of the Hackney Social Care System.

It's built using Docusaurus.

Table of contents

• Getting started
  • Prerequisites
  • Installation
• Usage
  • Running the application
  • Running a production build
  • Creating a new documentation page
• Documentation
  • Deployment
  • Related Repositories

Getting started

Prerequisites

• Node.js
• Yarn

Installation

1. Clone this repository

$ git clone git@github.com:LBHackney-IT/social-care-architecture.git

2. Install dependencies

$ yarn

Usage

Running the application

To run the application for local development:

$ yarn start

Running a production build

1. Build the application using:

$ yarn build

2. Run the application using:

$ yarn serve

Creating a new documentation page

Documentation files are stored in /docs. To add a new page:

1. Create a Markdown file within the /docs directory and if necessary, create a new directory within it
2. Update sidebars.js to update the side navigation (see Docusaurus documentation for the sidebar)

Docusaurus also supports MDX which means that you can write JSX within Markdown files and render them as React components. It has a number of other features, so feel free to explore more within the docs for Docusaurus.

Documentation

Deployment

The website is deployed using GitHub Pages and will automatically deploy using GitHub Actions when main is updated, see main.yml.

Related Repositories

Name	Purpose
LBH Social Care Frontend	Provides the UI/UX of the Social Care System.
Social Care Case Viewer API	Provides service API capabilities to the Social Care System.
Adult Social Care Care Package Builder Frontend	Provides the UI/UX of the Adult Social Care Package System.
Adult Social Care Care Package Builder API	Provides service API capabilities to the Adult Social Care Package System, allowing users to build and manage care packages.
Adult Social Care Package Builder Transactions API	Provides service API transaction capabilities to the Adult Social Care Package System, managing package transactions, pay runs, invoices, bills etc.
MASH Social Care Referral Form Ingestion Script	Apps Script code that retrieves MASH form data submitted to Google Sheets, processes it and sends the data into Social Care System
Infrastructure	Provides a single place for AWS infrastructure defined using Terraform as infrastructure as code as part of Hackney's new AWS account strategy. NB: Due to its recent introduction, the Social Care System has infrastructure across multiple places.
API Playbook	Provides guidance to the standards of APIs within Hackney.