This repository contains a basic implementation of a Rails app that queries the Companies House UK Public Data API
-
Ruby version: 3.0.3
-
Rails: 7.0.1
-
PostgreSQL: 10.19
-
Redis: 6.2.6
-
bundle install
-
bin/rails s
App should start and be running on http://localhost:3000
-
bin/rails db:create
-
bin/rails db:schema:load
-
Sidekiq is used for background jobs processing. Start it with:
bundle exec sidekiq
The app must be configured with a valid API key in order to request companies data and is expected to be included in rails credentials store config/credentials.yml.enc
with the following format:
companies_api:
base_url: https://api.company-information.service.gov.uk
api_key: <API-KEY>