mobilabsolutions/stash-sdk-dashboard

Dashboard code and documentation for the Stash! SDK

Stash! SDK Dashboard

Provides a web dashboard for the Stash! SDK.

Features

• Displays transactions
• Filter by date, status, payment method and reason
• Paging, if too many results
• Display a detailed view of transactions
• Transaction actions
  • Refund of "authorised" and "captured" Transactions
  • Capture of "pre-authorised" transactions
  • Reverse of "pre-authorised" transactions

Requirements

• node.js 10+
• Docker

Development

git clone git@github.com:mobilabsolutions/payment-sdk-dashboard-open
cd payment-sdk-dashboard-open
npm install
npm run dev
open http://localhost:3000/

Testing

npm run test        #all test (lint, type, jest)
npm run lint        #run eslint
npm run typescript  #run type checker
npm run jest        #run all jest test
npm run jest:watch  #run all jest test that are effected by a change

Dependencies

npm run updtr       # checks for outdated dependencies, updates them if tests do not fail

Docker

npm run docker
npm run docker:stop # to stop

Deployment

Run one of the following scripts to create a new Version

npm run version:patch
npm run version:minor
npm run version:major

Environment Keys

• PORT (default 3000)
• API_UPSTREAM
• NODE_ENV (production|development|test) do not change, set by package.json scripts
• SDK_ENV (production|development)

Built with

• typescript (Language)
• next.js (SSR Framework)
• react (View Lib)
• styled-components (css Lib)
• jest (Testing Framework)
• fastify (Webserver)
• docker (alpine-node)

Other Components

• react-dates (Date Range Picker)
• react-table (Lightweight, fast and extendable datagrids)
• formik (Assistant for building forms in React)
• react-select (Select control for React.)
• react-number-format (React component to format number in an input or as a text, useful for currency formats)

Folder Structure

• /asserts translation and styles
• /components Home of Atomic design structure of Components
• /hooks react hooks, middleware and business logic
• /k8s Kubernetes configs and scripts
• /pages entry points for the next.js app / check next.js documentation
• /scripts bash scripts for helper and build
• /server fastify backend (upstream, next.js, healthcheck)
• /static static files like fonts, images and css
• /test_utils test helpers

Feedback

The Stash! Dashboard is in active development, we welcome your feedback! Please use GitHub Issues or write us at stash@mobilabsolutions.com to report an issue or give a feedback.