Mono Lookup

Welcome to the Quickstart Guide for Mono Lookup. This guide will walk you through the steps to quickly set up Mono Lookup so that you can start verifying BVN information through our BVN iGree lookup APIs and integrate with this service.

1. Introduction

Mono Lookup is a simple app used for retrieving and verifying the BVN information of a user. In this guide, we'll show you how to set up Mono Lookup quickly and easily.

2. Prerequisites

Before you begin, make sure you have the following prerequisites in place:

• Node.js and npm installed
• Sign up on the Mono Dashboard ➡
• Create an App and fetch the generated Secret Key ➡

3. Setting Up Without Docker

Follow these steps to set up Mono Lookup without using Docker:

1. Clone and set up Mono Lookup:

   Download the Mono Lookup web application files from our GitHub repository. Navigate to the project directory using the command line.

   Bash

   git clone <https://github.com/kingkenway/quickstart-mono-lookup.git>
   cd quickstart-mono-lookup
   

2. Install Dependencies:

   Install the necessary dependencies using npm.

   Bash

   npm install
   
   

3. Configure API Key and Secret Key:

   Create a file named .env in the root of the Mono Lookup directory and add your API key and secret key.

   SECRET_KEY=your-secret-key
   PORT=3000
   

   Replace your-secret-key with your actual secret key.

4. Run Mono Lookup:

   Start the Mono Lookup application.

   Bash

   node app.js
   
   

   This will launch the application, and you can access it by opening your browser and navigating to http://localhost:3000.

4. Setting Up With Docker

If you prefer to use Docker for your setup, follow these steps:

Step 1: Clone the Mono Lookup repository from GitHub, which includes the Dockerfile:

git clone <https://github.com/kingkenway/quickstart-mono-lookup.git>

Step 2: Build the Docker image:

cd quickstart-mono-lookup
docker build -t quickstart-mono-lookup .

Step 3: Run a Docker container with the necessary environment variables set:

docker run -e SECRET_KEY=your-secret-key -p 3000:3000 quickstart-mono-lookup

Replace your-secret-key with your actual API secret key.

5. Configuration

In this section, you'll configure Mono Lookup using environment variables stored in a .env file. Create a file named .env in the root of the Mono Lookup directory and add the following:

SECRET_KEY=your-secret-key
PORT=3000

Replace your-secret-key with your actual API secret key.

6. Testing Your Setup

Before you start integrating Mono Lookup into your project, let's run the provided simple web app built with EJS, Express, and Node.js to ensure everything is set up correctly.

Prerequisites

Ensure you have Node.js and npm installed on your machine.

Steps

1. Open a terminal and navigate to the Mono Lookup directory.

2. Install the necessary dependencies.

   Bash

   npm install
   
   

3. Start the Express app:

   Bash

   node app.js
   
   

4. Open your browser and visit http://localhost:3000. You should see the Mono Lookup web app in action.

7. Next Steps

Congratulations! You've successfully set up Mono Lookup. Now, you're ready to start building amazing applications with our API. Here are some suggested next steps:

• Link to API Reference
• Information on how to integrate Mono Lookup into your project can be found here.
• Support and community resources can be found here.

GitHub link to clone: https://github.com/kingkenway/quickstart-mono-lookup.git

Deployed link to test: https://bvn-quickstart.onrender.com/

The provided web app is a simple demonstration of Mono Lookup integration. It displays a basic webpage at http://localhost:3000, and you can explore further by interacting with the Mono Lookup functionalities embedded in the app.

Feel free to inspect the code in the provided files (app.js, views/index.ejs and the controllers) to understand how Mono Lookup is integrated into an Express web app.

Remember to replace placeholders with your actual secret key, and other relevant information in the configuration steps.

If you encounter any issues or have questions, don't hesitate to reach out to our integration team at [email protected].

Happy coding!