Giter Club home page Giter Club logo

hmrc.page-capture-service's Introduction

The functionality provided by this service has been moved to accessibility-assessment

page-capture-service

The Page Capture Service is a lite weight, single file service built using expressjs. The service exposes a single API to capture HTML pages (along with associated css/javascript assets) uploaded via HMRC's page-capture-chrome-extension. These pages are then written to a configurable location on the file system.

Getting started

You can pull all required dependencies down by running:

npm install

...from the project root directory.

Running the server locally

To run the server, execute:

node server.js

...from the project root directory.

The service is currently configured to start on port 6001 as we allow access to localhost 6001-6010 from our build slave side car containers.

Service configuration

When running the service locally you can update config.js, or set the following environment variables:

  • port: defaults the environment variable named APP_PORT if set. Otherwise, it's set to 6001
  • captureAllPages: defaults to the environment variable named CAPTURE_ALL_PAGES if set. Otherwise, it's set to false. When set to false the service will capture a single version of each page by path. Setting this to true will capture every page uploaded to the service.
  • pagesParentPath: defaults to the value of the WORKSPACE environment variable for use on the Jenkins slave. If the WORKSPACE environment variable is not set this value is set to the current working directory.

License

This code is open source software licensed under the Apache 2.0 License.

hmrc.page-capture-service's People

Contributors

dannyprok avatar ejayaraman avatar hmrc-web-operations avatar

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.