FeatureToggleStudy / digital-hub

Digital Prisons Hub

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Digital Hub for Prisons

CircleCI

This is a mono-repo of the following projects

moj-be/ - Backend service using a customized Drupal instance
moj-node/ - Frontend NodeJS service
moj-matomo/ - Matomo analytics

Together these make the Digital Hub for prisons service.

Run the Digital Hub locally

Prerequisites

The following software is required

Docker
CMake
Node v10.5.3
Composer

Starting the service

Pull the latest version of the service

docker-compose pull

To start the service

docker-compose up hub-be hub-fe

You can then visit the service locally on http://localhost:10001, with the Drupal backend exposed on http://localhost:11001

Using Docker-Compose for development

The development version of the Digital-Hub makes use of additional Docker-Compose configuration that mounts volumes on the host machine.

Pull the dependencies for both the frontend and backend projects

cd moj-node && make build-deps && cd ..
cd moj-be && make build-deps && cd ..

Start the service

docker-compose -f docker-compose.yml -f docker-compose-override.yml up hub-be hub-fe

Notes

All Docker Images are pushed to the Docker Hub organisation here https://hub.docker.com/u/mojdigitalstudio/ with the exception of Matomo which is pushed to a private registry in Azure

If you have Homebrew installed you can run the following in the root of the repository

brew bundle

This will install all of the packages you will need to do development on the project or you can inspect the Brewfile in the root and see what packages you will need

Contributing to the project

If you wish to work on the Digital Hub to provide more content types or features, contributions are welcome

Clone the repo

git@github.com:ministryofjustice/digital-hub.git

Create a feature branch

git checkout -b feature/your-new-feature

Commit and push your changes and raise a Pull Request

About

Digital Prisons Hub


Languages

Language:JavaScript 42.8%Language:PHP 36.1%Language:HTML 11.5%Language:CSS 8.2%Language:Dockerfile 0.6%Language:Shell 0.3%Language:Makefile 0.3%Language:Ruby 0.1%Language:Io 0.0%