Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api endpoint docs #1141

Merged
merged 7 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
207 changes: 166 additions & 41 deletions README.md

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions demos/client-bundle-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ This project is a _minimal_ example demonstrating how to include the Prosopo Pro
Run these commands from the root of the [captcha](https://github.com/prosopo/captcha) repo:

```bash
cp demos/client-example-server/env.development demos/client-example-server/.env.development && \
cp demos/client-example/env.development demos/client-example/.env.development && \
cp dev/scripts/env.development dev/scripts/.env.development && \
cp dev/scripts/env.development packages/cli/.env.development && \
cp dev/scripts/env.development packages/procaptcha-bundle/.env.development && \
docker compose --file ./docker/docker-compose.development.yml up -d && \
npm i && \
Expand Down
22 changes: 22 additions & 0 deletions demos/client-example-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,25 @@ This example server implements signup, login and authorisation methods for a typ
is based
on [an article written by Agustin Fernandez](https://www.asapdevelopers.com/build-a-react-native-login-app-with-node-js-backend/)
and is adapted to use a Mongo In-Memory Database. This backend server integrates with the client-example React app.

## How to run locally

### 1. Build & Deploy

From the roof of this repository, run the following commands:

```bash
cp demos/client-example-server/env.development demos/client-example-server/.env.development && \
cp dev/scripts/env.development dev/scripts/.env.development && \
docker compose --file ./docker/docker-compose.development.yml up -d && \
npm i && \
npm run build:all && \
npm run setup:all && \
npm run start:server
```

### 2. Use the API

The server should now be running at localhost:9228. You can customise this in the `.env.development` file. Run this
example API in conjunction with the [client-example](https://github.com/prosopo/captcha/tree/main/demos/client-example)
React app.
5 changes: 1 addition & 4 deletions demos/client-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@ This project is a _minimal_ example demonstrating how to include Prosopo Procapt
Run these commands from the root of the [captcha](https://github.com/prosopo/captcha) repo:

```bash
cp demos/client-example-server/env.development demos/client-example-server/.env.development && \
cp demos/client-example/env.development demos/client-example/.env.development && \
cp dev/scripts/env.development dev/scripts/.env.development && \
cp dev/scripts/env.development packages/cli/.env.development && \
cp dev/scripts/env.development packages/procaptcha-bundle/.env.development && \
docker compose --file ./docker/docker-compose.development.yml up -d && \
npm i && \
npm run build:all && \
npm run setup:all && \
npm run start:all
npm run start:demo
```

### 2. Visit the App
Expand Down
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docs.prosopo.io
docs.prosopo.io
4 changes: 2 additions & 2 deletions docs/assets/main.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

9 changes: 3 additions & 6 deletions docs/assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -327,17 +327,14 @@ dd {
}

/* Footer */
.tsd-generator {
footer {
border-top: 1px solid var(--color-accent);
padding-top: 1rem;
padding-bottom: 1rem;
max-height: 3.5rem;
}

.tsd-generator > p {
margin-top: 0;
margin-bottom: 0;
padding: 0 1rem;
.tsd-generator {
margin: 0 1em;
}

.container-main {
Expand Down

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/_prosopo_api.api_HttpError.HttpError.html

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/classes/_prosopo_api.api_ProviderApi.default.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

86 changes: 43 additions & 43 deletions docs/classes/_prosopo_captcha_contract.query_captcha.default.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_cli.reloader.default.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.asyncFactory.AsyncFactory.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoApiError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoBaseError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoCliError.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoDBError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoDatasetError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.error.ProsopoEnvError.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/_prosopo_common.error.ProsopoError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/_prosopo_common.logger.Loggable.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

5 changes: 0 additions & 5 deletions docs/classes/_prosopo_common.signer.default.html

This file was deleted.

Loading
Loading