https://github.com/softwaremill/sakiewka-crypto
https://github.com/softwaremill/sakiewka-crypto
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/softwaremill/sakiewka-crypto
- Owner: softwaremill
- Created: 2018-07-12T06:56:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-08T13:09:41.000Z (over 2 years ago)
- Last Synced: 2025-01-18T06:42:44.095Z (about 1 year ago)
- Language: TypeScript
- Size: 2.84 MB
- Stars: 1
- Watchers: 11
- Forks: 1
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sakiewka-crypto
This is a library intended to be used as a dependency to other packages. It handles most of the wallet functionalities and communication with backend.
### Usage:
First run `npm ci`
### Docs:
Run `npm run generate-docs`
Open `/docs/index.html`
##### Tests:
To run integration tests you have to specify `BACKEND_API_URL` in `.env` file.
`npm test` - Runs all tests
`npm run test-unit` - Runs unit tests
`npm run watch-test` - Runs tests in watch mode
`npm run watch-test-unit` - Runs unit tests in watch mode
##### Build:
`npm run build` - Builds files into dist/ folder
### package.json modification:
Do not modify package.lock manually. Always use `npm install` when adding or updating packages.
### Design
There are two families of components: api and module.
Components from api family are used to provide unified access layer for our backend api.
Components from module family consits mostly of cryptographic functions which can be executed locally.