Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 2.41 KB

README.md

File metadata and controls

72 lines (50 loc) · 2.41 KB
Raw

@deriv/cashier

Description

This repository is a workspace of deriv-app monorepo and covers the cashier page in app.deriv.com. (You need to be logged in to see the page.) This workspace covers:

  • Deposit, Withdraw and Transfer (for both Fiat and Crypto)
  • Deposit and withdraw with Payment agents
  • Deposit with p2p and onRamp

How to Install the Project

Follow the instructions here.

How to Work with the cashier workspace

To run and work on this workspace you need to use npm run serve cashier command along with npm run serve core. Webpack will watch changes in cashier so that if you made any changes in this package, it will automatically rebuild cashier and recompile core. You can use it like this in your code:

const cashier = require('@deriv/cashier');

Folder Structure

build
    ├── ...
    ├── webpack-config.js
src
    ├── _common
    ├── components
    ├── config
    ├── constants
    |   |──routes-config.js
    ├── containers
    ├── pages
    ├── public
    ├── stores
    ├── utils
    │   ├── validator
    |   |   ├──...
    |   |   ├── validator.js

components: This folder contains all the reusable components that we need for developing this workspace. We have a separate folder for each component.

constants: We add the static data structures needed for the workspace here.

containers: This folder contains the wrappers we use for the whole workspace.

pages: This is the place for putting all the features which are visible through the browser. We have separate folder for each feature. The features developed in this folder also have been exported through the webpack for the use of other packages (like appstore).

public: All shared files (like .svg files) will be placed here.

store: We use Mobx as state management tool in Cashier, and this is the place for putting the relevant store files. Also, for each store file we have a test file in tests folder.

utils: We place all the common and helper methods which are required for the workspace in this folder.

Troubleshooting

  • Icon missing: If the icons are missing, you only need to build this workspace. You can do this by running the build command from the root directory (/deriv-app):
npm run build