@block-auth.io/blockauth-sdk
Version:
Block-Auth Auth SDK is a SaaS service blockchain based authentication service. It provides a simple and secure way to authenticate users in your application.
66 lines (43 loc) • 2.12 kB
Markdown
# Block-Auth SDK library JS
[](https://gitlab.com/blockauthio/blockauth-sdk/-/commits/main) [](https://gitlab.com/blockauthio/blockauth-sdk/-/commits/main) [](https://gitlab.com/blockauthio/blockauth-sdk/-/releases)
This is a SDK-react for the BlockAuth project. Library written in javascript to provide a simple way to interact with the Block-Auth
authentication service with users extensions, insights, and more.
# How to use?
Use the official documentation at [block-auth.io](https://docs.block-auth.io/) to learn how to use the SDK.
## Development
Install dependencies
```bash
npm install
```
CI/CD
```bash
npm run ci
```
Start the development server
```bash
npm run dev
```
After making changes to the code, run the following command to format the code, run the linter, and start the development server:
```bash
npm run css && npm run lint && npm run format && npm run dev
```
## NPM Scripts
| Script | Description |
| :-------- | :------- |
| `dev` | Starts the development server |
| `css` | Builds the CSS |
| `css:dev` | Builds the CSS in development mode |
| `test` | Runs the tests and generates a coverage report |
| `lint` | Runs the linter |
| `lint:fix` | Runs the linter and fixes the errors |
| `format` | Formats the code |
| `build` | Builds the app for production |
| `preview` | Builds the app for production and previews it locally |
| `ci` | Runs the tests, linter, and code formatter |
| `stories` | Starts the Storybook server |
| `stories:build` | Builds the Storybook app for production |
| `docs` | Starts the documentation server |
| `docs:build` | Builds the documentation app for production |
| `clean` | Removes `dist`, `dist-stories`, `dist-docs`, `package-lock.json`, `.coverage` and `node_modules` |
## Authors
Block-Auth.io Team