Skip to content

readme: make table prettier #101

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 2, 2023
Merged

readme: make table prettier #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a10e2d6
readme: make table prettier
adam-maj Sep 2, 2023
bbcf82b
Update
adam-maj Sep 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,22 @@ For updates on your requests, you can either poll using the `get` (`/tranasction

| Variable Name | Description | Default Value | Required |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- |
| `HOST` | Host name of the API Server | `localhost` | false |
| `PORT` | Port number of the API Server | `3005` | false |
| `THIRDWEB_API_KEY` | API Key to access ThirdWeb API | | true |
| `POSTGRES_HOST` | PostgreSQL Host Name | | true |
| `POSTGRES_DATABASE_NAME` | PostgreSQL Database Name | | true |
| `POSTGRES_USER` | PostgreSQL Username | | true |
| `POSTGRES_PASSWORD` | PostgreSQL Password | | true |
| `POSTGRES_PORT` | PostgreSQL Port | | true |
| `POSTGRES_USE_SSL` | Flag to indicate whether to use SSL | | true |
| `TRANSACTIONS_TO_BATCH` | Number of transactions to batch process at a time. | `10` | false |
| `CHAIN_OVERRIDES` | Pass your own RPC urls to override the default ones. This can be file or an URL. See example override-rpc-urls.json | | false |
| `OPENAPI_BASE_ORIGIN` | Base URL for Open API Specification. Should be the Base URL of your App. | `http://localhost:3005` | false |
| `THIRDWEB_SDK_SECRET_KEY` | Create an API KEY on Thirdweb Dashboard and copy the SecretKey. | | true |
| `MINED_TX_CRON_ENABLED` | Flag to indicate whether to run the cron job to check mined transactions. | `true` | false |
| `MINED_TX_CRON_SCHEDULE` | Cron Schedule for the cron job to check mined transactions. | `*/30 * * * *` | false |
| `MIN_TX_TO_CHECK_FOR_MINED_STATUS` | Number of transactions to check for mined status at a time. | `50` | false |
| `HOST` | Host name of the API Server | `localhost` | ❌ |
| `PORT` | Port number of the API Server | `3005` | ❌ |
| `THIRDWEB_API_KEY` | API Key to access ThirdWeb API | | ✅ |
| `POSTGRES_HOST` | PostgreSQL Host Name | | ✅ |
| `POSTGRES_DATABASE_NAME` | PostgreSQL Database Name | | ✅ |
| `POSTGRES_USER` | PostgreSQL Username | | ✅ |
| `POSTGRES_PASSWORD` | PostgreSQL Password | | ✅ |
| `POSTGRES_PORT` | PostgreSQL Port | | ✅ |
| `POSTGRES_USE_SSL` | Flag to indicate whether to use SSL | | ✅ |
| `TRANSACTIONS_TO_BATCH` | Number of transactions to batch process at a time. | `10` | ❌ |
| `CHAIN_OVERRIDES` | Pass your own RPC urls to override the default ones. This can be file or an URL. See example override-rpc-urls.json | | ❌ |
| `OPENAPI_BASE_ORIGIN` | Base URL for Open API Specification. Should be the Base URL of your App. | `http://localhost:3005` | ❌ |
| `THIRDWEB_SDK_SECRET_KEY` | Create an API KEY on Thirdweb Dashboard and copy the SecretKey. | | ✅ |
| `MINED_TX_CRON_ENABLED` | Flag to indicate whether to run the cron job to check mined transactions. | `true` | ❌ |
| `MINED_TX_CRON_SCHEDULE` | Cron Schedule for the cron job to check mined transactions. | `*/30 * * * *` | ❌ |
| `MIN_TX_TO_CHECK_FOR_MINED_STATUS` | Number of transactions to check for mined status at a time. | `50` | ❌ |

## Setup Instructions

Expand Down