https://github.com/nice-digital/bnf-gatsby

Website for NICE British National Formulary (BNF) and British National Formulary for Children (BNFC). Built with Gatsby and using the NICE Design System
https://github.com/nice-digital/bnf-gatsby

bnf bnfc gatsby gatsby-site gatsbyjs

Last synced: 3 months ago
JSON representation

Website for NICE British National Formulary (BNF) and British National Formulary for Children (BNFC). Built with Gatsby and using the NICE Design System

• Host: GitHub
• URL: https://github.com/nice-digital/bnf-gatsby
• Owner: nice-digital
• License: mit
• Created: 2021-12-07T15:54:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-05T09:38:03.000Z (5 months ago)
• Last Synced: 2024-09-05T16:01:13.020Z (5 months ago)
• Topics: bnf, bnfc, gatsby, gatsby-site, gatsbyjs
• Language: TypeScript
• Homepage:
• Size: 3.87 MB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BNF and BNFC

> Website for NICE British National Formulary (BNF) and British National Formulary for Children (BNFC) built with Gatsby and using the NICE Design System

[**:rocket: Jump straight to getting started**](#rocket-set-up)

## What is it?

The BNF, or British National Formulary, provides guidance to health practitioners on prescribing, dispensing and administering medicines.

It's a microsite, updated once a month from a feed. It's built with Gatsby, a React-based static site generator, and is styled using components from the NICE Design System.

This project produces website for both the BNF (standard formulary) and BNFc (the version for children).

## Project structure

| Folder                                      | Purpose                                       |

| ------------------------------------------- | --------------------------------------------- |

| [gatsby](gatsby#readme)                     | Static site built with React and Gatsby       |

| [functional-tests](functional-tests#readme) | Browser-based functional tests in WebdriverIO |

> Note: Each of these folders has its own readme with detailed setup steps etc

## Stack

This is the high level stack. Each of the sub-projects (gatsby/functional-tests) has its own readme with more detailed stack.

### Software

- [VS Code IDE](https://code.visualstudio.com/)

  - With recommended extensions (VS Code will prompt you to install these automatically)

- [Gatsby v4](https://www.gatsbyjs.org/) and [React](https://reactjs.org/) for static site generation

- [WebdriverIO v7](https://webdriver.io/) for browser-based functional tests

- [NICE Design System](https://design-system.nice.org.uk/)

## :rocket: Set up

The easiest way to get the project running is:

1. Use [Volta](https://volta.sh/) to automatically use the correct version of Node pinned in package.json; or install the correct version of Node manually if you're not using Volta

2. Clone this repository

3. Open the root of the repository in VS Code

   1. Install recommended extensions when prompted

4. Install dependencies:

   1. Open the command palette (_Ctrl+Shift+P_) in VS Code, then:

   2. Run 'npm: Install Dependencies' (and choose 'Run all commands listed below')

   3. This should run `npm i` for each Node project. If this doesn't work then run `npm i` in each folder with a package.json manually.

5. Go to the 'Run and Debug' panel (_Ctrl+Shift+D_) in VS Code

6. Run `LAUNCH BNF/BNFC`

Launching the app via `LAUNCH BNF/BNFC` runs the Gatsby site in dev mode on http://localhost:8000/, and launches it in Chrome for debugging once it's built and running.

> Note: there are more granular ways to run each part of the project, either via an IDE or via the command line. See each sub-folders's readme for more details.