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

It's built using Docusaurus.

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

• Node.js
• Yarn

1. Clone this repository

$ git clone [email protected]:LBHackney-IT/social-care-architecture.git

2. Install dependencies

$ yarn

To run the application for local development:

$ yarn start

1. Build the application using:

$ yarn build

2. Run the application using:

$ yarn serve

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.

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