Git Product home page Git Product logo

rsp-public-portal's Introduction

RSP Public Portal

Public portal for Roadside Payments Project, aiming to enable drivers and/or their operators to pay penalty fines issued by DVSA.

This project is a NodeJS + Express based application and is meant to be served through a serverless environment (AWS Lambda + S3 Bucket + DynamoDB + API Gateway).

Work in progress.

DVSA Front-end Kit

This project uses the DVSA front-end kit, which means all view templates/macros are available and should be used whenever possible to ensure maximum consistency accross DVSA projects.

More information about this available on github

Running the app locally

To run this project locally, clone the repository and the instructions below:

  1. nvm use 16.16 Set Node to the required versionß

  2. npm install Installs all project dependencies

  3. npm run build Builds the dvsa-frontend specific resources and also the server related code. This will create a build/ directory with the transpiled code and required assets as well

  4. npm run start-server Runs the server from the build/ directory. Note that this will use the Views and Assets that sit within the build/ directory. There is no automatic reloading (on source code change) so for development purposes please use the next command instead.

  5. npm run start-dev-server Runs the application in development mode, meaning that source code changes will trigger a rebuild and server reload.

Testing

To run unit tests, run npm run test or test:watch to re-run the tests automatically whenever source code changes

Distribution

Run the following command to build, bundle and package the required artifacts. npm run package

The resulting archive (package.zip) will be available on the dist/ directory and ready for deployment.

Git Hooks

Please set up the following prepush git hook in .git/hooks/pre-push

#!/bin/sh
npm run prepush && git log -p | scanrepo

Security

Please install and run the following securiy programs as part of your testing process:

https://github.com/awslabs/git-secrets

  • After installing, do a one-time set up with git secrets --register-aws. Run with git secrets --scan.

https://github.com/UKHomeOffice/repo-security-scanner

  • After installing, run with git log -p | scanrepo.

These will be run as part of prepush so please make sure you set up the git hook above so you don't accidentally introduce any new security vulnerabilities.

rsp-public-portal's People

Contributors

jameshighfield avatar ammarhaiderbjss avatar annadodson avatar fabiosimaobjss avatar jakedanielturner avatar mgoldson avatar sdh100shaun avatar ibrahimjassat avatar seanmcneilly2 avatar srfabio avatar jerotire avatar md23 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.