QuickStart

Before you begin using ScanAI, ensure that you have the following requirements installed and configured:

• Node.js (>= 16.x)

ScanAI relies on Node.js for execution. To check if you have the correct version installed, run:

node -v

If you need to install or upgrade Node.js, visit https://nodejs.org/.

• A package manager (npm or yarn)

You need a package manager like npm or yarn to install dependencies.

npm

• Check if npm is installed:

npm -v

yarn

• A valid OpenAI API key

ScanAI uses OpenAI for its core, so you need an API key to start using ScanAI tools.

• Configure environment variables

ScanAI requires environment variables for configuration. Refer to .env.example for the necessary parameters.

1

Copy the example env file

Copy the .env.example file to .env:

cp .env.example .env

2

Edit the .env file

Open the .env file and replace placeholder values with your actual credentials.

Once these prerequisites are set up, you are ready to install and configure ScanAIfor development!

References:

• .env.example: ./ (keep the original link in your project)

• Node.js Official Website: https://nodejs.org/