Giter VIP home page Giter VIP logo

uk-companies's Introduction

CompaniesHouse UK

This repository contains a basic implementation of a Rails app that queries the Companies House UK Public Data API

Tech stack

  • Ruby version: 3.0.3

  • Rails: 7.0.1

Dependencies

  • PostgreSQL: 10.19

  • Redis: 6.2.6

Setup

  1.  bundle install
    
  2.  bin/rails s
    

App should start and be running on http://localhost:3000

Database initialization

  1.  bin/rails db:create
    
  2.  bin/rails db:schema:load
    

Services

  1. Sidekiq is used for background jobs processing. Start it with:

     bundle exec sidekiq
    

API credentials

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>

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.