Skip to content

Crown-Commercial-Service/ccs-conclave-identifier-service

Repository files navigation

GitHub issuesVersion GitHub contributors GitHub last commit


Crown-Commercial-Service

Conclave Identifier Service

A Ruby on Rails-powered API
Contents
  1. About
  2. Setup
  3. Usage
  4. Roadmap
  5. Changelog
  6. Contact


About This Project

The Crown Commercial Service's Contingency ID Service, for Conclave/PPG. A service to assign a ccs identifier to organisations that don't have a Companies House, Charities, NHS, or DUNs number.

Tech Stack




Setup

For help or guidance in downloading and running the application, see the following subsections.

Prerequisites

You must have npm (node package manager) and Nodejs installed on your system.
You must also have rails installed on your system.
Finally, you must have postgresql installed on your system.


Installation

  1. Clone/Download:
git clone https://github.com/Crown-Commercial-Service/ccs-conclave-identifier-service.git
  1. Install:
bundle install
  1. Create, migrate and seed the database:
bundle exec rake db:setup
  1. Start:
rails s

Optional: Disable authorisation by commenting out before_validation line in app/contollers/identifiers/id/organisations_controller.rb

#before_action :validate_api_key




Usage

Endpoint Action/Desc. Full URI (hosted locally, for some port; e.g.: 3000) Request Type
  • "identifiers/id/ppon"
Create:
Creates PPON Number and returns JSON payload.
POST




Changelog

Version Date Pull Request Number Changes Description
0.0.1 2022-04-20 #1
  • Initial Developer Commit.
  • Add initial directory structure and files.
  • Update README.md
0.0.2 2022-04-21 #2
  • Tidy up unnecessary repo files.
  • Update README.md
0.0.3 2022-04-21 #3
  • Update ruby version to fix buildpack issue on CF delpoy.
  • Update README.md




Contact

Tom Berey; Lead Developer;thomas.berey@crowncommercialservice.gov.uk;
Dom Sutcliffe; Developer;dom.sutcliffe@crowncommercialservice.gov.uk;
Sam Boothroyd; Developer;sam.boothroyd@crowncommercialservice.gov.uk;