⚠️ EoE React Template (Unofficial)

Lightweight, unofficial starter React template intended for analysts in the East of England region. This project is not maintained by NHS Digital or any official body, and comes with no guarantees or support. Use at your own risk.

It is designed to give analysts a quick starting point; please read the notes below carefully before adopting it.
Note: the published npm package does not include any inbound repository metadata – the code lives inside a private Foundry environment – and you can still publish it publicly by running npm publish --access public.

EoE React Template

This repository contains a React application template for NHS East of England with Palantir Foundry OSDK integration.

Template Structure

The application is structured as a template package that can be used to create new projects or be updated in existing projects without affecting user customizations.

/src
  /template/           # Template code (updated with template updates)
    /components/       # Reusable components
    /hooks/            # Custom React hooks
    /styles/           # CSS and styling
    /utils/            # Utility functions
    /core/             # Core template files
  /core/               # User customizable code (preserved during updates)
    /components/       # Custom components
    /pages/            # Application pages
    /hooks/            # Custom hooks
    /config/           # Configuration

Development

Local Development

To run the application locally:

npm install
npm run dev

Creating a New Project from the Template

Once this package is published to npm:

npx create-eoe-app my-new-project
cd my-new-project
npm install
npm run dev

Updating the Template in an Existing Project

To update the template in an existing project:

npx update-eoe-template

Customizing the Template

Adding Custom Components

Add custom components to src/core/components/:

// src/core/components/CustomComponent.tsx
import React from 'react';

const CustomComponent = ({ title }) => {
  return <div>{title}</div>;
};

export default CustomComponent;

Adding Custom Pages

1. Create a new page in src/core/pages/
2. Add the route to src/core/config/routes.ts

Custom Hooks

Add custom hooks to src/core/hooks/ for reusable logic.

Building for Production

To build the application for production:

npm run build

To build the template package:

npm run build:template

Palantir Foundry OSDK Integration

This template includes integration with Palantir Foundry's Ontology SDK (OSDK) for data access.

• The OSDK client is configured in src/template/core/client.ts
• Authentication is handled in src/template/core/AuthCallback.tsx
• Object types are accessed through the @eoereacttemplate/sdk package

Original Features

• NHS Styling: Fully compliant with NHS design system guidelines and color palette
• Reusable Components: Library of common UI elements with consistent styling
• Data Integration: Seamless integration with Palantir Foundry Ontology SDK
• Responsive Design: Optimized for both desktop and mobile viewing
• Customizable: Easy to adapt and extend for specific reporting needs

⚠️ Disclaimer

This software is provided “as is” without warranty of any kind. It’s a community‑supported, unofficial template, and you are responsible for validating its suitability for your work. It may contain references to Palantir Foundry or internal tooling that are not functional outside the original environment.

The .npmrc file present in the repository is also not published with the package; it's strictly for internal use when working inside the Palantir network and is ignored by npm when creating the public tarball.

License

This project is intended for NHS England use.