Skip to content

Commit

Permalink
fix(docs): fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alonp99 committed Jun 28, 2023
1 parent d5e8458 commit 4fcbbb6
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 61 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
"playwright:install": "nx run-many --target=playwright:install",
"dev": "nx run-many --target=dev --projects=@ballerine/workflows-service,@ballerine/backoffice-v2",
"start": "nx run-many --target=start --projects=@ballerine/web-ui-sdk",
"build": "nx run-many --target=build --projects=@ballerine/workflow-browser-sdk,@ballerine/web-ui-sdk,@ballerine/workflow-core,@ballerine/workflow-node-sdk,@ballerine/rules-engine-lib,@ballerine/common,@ballerine/workflows-service,@ballerine/workflows-websocket-service",
"build": "nx run-many --target=build --projects=@ballerine/workflow-browser-sdk,@ballerine/web-ui-sdk,@ballerine/workflow-core,@ballerine/workflow-node-sdk,@ballerine/rules-engine-lib,@ballerine/common,@ballerine/workflows-service,@ballerine/websocket-service",
"web-ui-sdk:dev": "nx run @ballerine/web-ui-sdk:dev",
"web-ui-sdk:start": "nx run @ballerine/web-ui-sdk:start",
"workflows-service:start": "nx run @ballerine/workflows-service:start",
"workflows-websocket-service:start": "nx run @ballerine/workflows-websocket-service:start",
"websocket-service:start": "nx run @ballerine/websocket-service:start",
"workflow-browser-sdk:build": "nx run @ballerine/workflow-browser-sdk:build",
"workflow-browser-sdk:dev": "nx run @ballerine/workflow-browser-sdk:dev",
"workflow-browser-sdk:watch": "nx run @ballerine/workflow-browser-sdk:watch",
Expand Down
4 changes: 2 additions & 2 deletions services/websocket-service/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@ballerine/workflows-websocket-service",
"name": "@ballerine/websocket-service",
"version": "0.0.1",
"description": "workflows-websocket-service",
"description": "websocket-service",
"private": false,
"scripts": {
"build": "nest build",
Expand Down
55 changes: 9 additions & 46 deletions websites/docs/src/pages/en/learn/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ layout: '../../../layouts/MainLayout.astro'

### Prerequisites
Before you can install and use Ballerine, you will need the following:

1. **Node.js**: Ballerine requires Node.js. If not installed, download and install it from [here](https://nodejs.org/).

2. **pnpm**: This is a fast, disk space efficient package manager for JavaScript. You can install it globally with the following command:
```
npm install -g pnpm
```
## Install prerequisites:
- Node.js (Minimum version 18) (you can install node via NVM: [Install NVM](https://github.com/nvm-sh/nvm))
- Latest PNPM version (Minimum version 8.0) ([Install PNPM](https://pnpm.io/installation))
- Docker and docker compose ([Docker](https://docs.docker.com/desktop), [Docker Compose](https://docs.docker.com/compose/install))

### Installation Steps

Expand All @@ -38,9 +35,12 @@ Before you can install and use Ballerine, you will need the following:
pnpm run monorepo:init
```

5. **Start the API example**: To start the example API, use the following command:

## Run one of the examples, or follow a guide from the [guide sections](https://docs.ballerine.com/en/learn/simple-kyb-guide/):

**Start the KYC example**: To start the example API, use the following command:
```shell
pnpm run api-manual-review-example
pnpm run kyc-manual-review-example
```

After performing these steps, the backoffice should be running on http://localhost:5137/, and the workflow service will be accepting calls at http://localhost:3000/.
Expand All @@ -49,40 +49,3 @@ The default username and password for the backoffice are:

- Username: admin@admin.com
- Password: admin




v2

To set up a local environment, follow these steps:

1. #### Install prerequisites:
- Node.js (Minimum version 18) (you can install node via NVM: [Install NVM](https://github.com/nvm-sh/nvm))
- Latest PNPM version (Minimum version 8.0) ([Install PNPM](https://pnpm.io/installation))
- Docker and docker compose ([Docker](https://docs.docker.com/desktop), [Docker Compose](https://docs.docker.com/compose/install))

2. #### Clone and install the project:
1. Clone the project:
```sh
git clone https://github.com/ballerine-io/ballerine.git
```
2. Install npm depenencies:
```sh
pnpm install
```
3. Initialize monorepo:
```sh
pnpm monorepo:init
```

3. #### Run the example
```sh
pnpm kyc-manual-review-example
```

Once the process is complete, _2 tabs_ will open in your browser:

1. http://localhost:5173/ - for the _document collection flow_
2. http://localhost:5137/ - for the _backffice_
(It's recommended to have them positioned side-by-side).
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: SDK UI Flows
description: SDK UI flows documentation
title: Interacting with Workflows
description: Interacting with Workflows
layout: ../../../layouts/MainLayout.astro
---

# Interacting with Workflows

Once a workflow is defined, you can create instances of it and interact with them in various ways. Each instance of a workflow is unique, with its own ID and context.

## Workflow Instances
Expand Down
5 changes: 2 additions & 3 deletions websites/docs/src/pages/en/learn/understanding_workflows.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: SDK UI Flows
description: SDK UI flows documentation
title: Understanding Workflows
description: Understanding Workflows
layout: ../../../layouts/MainLayout.astro
---
# Understanding Workflows

A workflow, in a broad sense, is a series of steps or a process that takes an input and produces an output. It's a sequence of tasks or procedures that lead to some desired outcome. However, in the context of our system, workflows are not just mere sequences but orchestrated, complex processes that involve dynamic decision-making and interactions. A good example is the "Know Your Business (KYB)" process, as explained in our [KYB guide](../guides/KYB_Workflow_Implementation_Guide.md).

Expand Down
6 changes: 2 additions & 4 deletions websites/docs/src/pages/en/learn/workflow_definitions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: SDK UI Flows
description: SDK UI flows documentation
title: Workflow Definitions
description: Workflow Definitions
layout: ../../../layouts/MainLayout.astro
---

# Workflow Definitions

A workflow definition is a JSON object that specifies the structure and behavior of a workflow. It outlines the states, transitions, actions, and events that the workflow is comprised of.

## Components of a Workflow Definition
Expand Down

0 comments on commit 4fcbbb6

Please sign in to comment.