Installation

Install the Flutterwave Rave Java Library in your project using Maven or JAR file

Prerequisites

Before you begin, ensure you have:

• Java Development Kit (JDK) 1.7 or higher installed
• A Java IDE (NetBeans, IntelliJ IDEA, Eclipse, etc.)
• Maven (if using Maven installation method)
• A Flutterwave account with API keys

Don’t have a Flutterwave account yet? Sign up for a test account to get started with sandbox API keys.

Installation methods

You can install the Rave Java Library using either Maven (recommended) or by manually adding the JAR file to your project.

Maven

<dependency>
  <groupId>com.github.theresasogunle</groupId>
  <artifactId>Rave</artifactId>
  <version>1.0.1</version>
  <type>jar</type>
</dependency>

Option 1: Maven installation (recommended)

If you’re using Maven for dependency management, add the following dependency to your pom.xml file:

1. Open your pom.xml

   Locate the pom.xml file in your project root directory.

2. Add the dependency

   Add the Rave dependency to your <dependencies> section:

   <dependency>
     <groupId>com.github.theresasogunle</groupId>
     <artifactId>Rave</artifactId>
     <version>1.0.1</version>
     <type>jar</type>
   </dependency>
   
3. Update Maven dependencies

   Run mvn clean install in your terminal or use your IDE’s Maven sync feature to download the library.

4. Verify installation

   Check that the library appears in your project’s dependencies. You should now be able to import classes from the com.rave package.

You can also find the library on Bintray for additional repository configuration options.

Option 2: JAR file installation

If you’re not using Maven, you can manually add the JAR file to your project:

1. Download the JAR file

   Download the latest Rave-Java-Library JAR file from the GitHub releases page.

2. Add JAR to your project

   Follow the instructions for your IDE below to add the JAR file to your project’s classpath.

IDE setup instructions

Once you have the JAR file, follow the instructions for your IDE:

NetBeans IDE

1. Right-click on your project in the Project Explorer
2. Select "Properties" from the context menu
3. Navigate to "Libraries" in the left panel
4. Click on the "Compile" tab
5. Click "Add JAR/Folder" button
6. Browse and select the downloaded Rave JAR file
7. Click "OK" to apply changes

Verify your installation

To verify that the library is properly installed, create a simple test file:

VerifyInstallation.java

import com.github.theresasogunle.RaveConstant;
import com.github.theresasogunle.Environment;

public class VerifyInstallation {
    public static void main(String[] args) {
        // If this compiles without errors, the library is installed correctly
        RaveConstant.ENVIRONMENT = Environment.STAGING;
        System.out.println("Rave Java Library is installed successfully!");
    }
}

If the code compiles and runs without errors, your installation is complete!

If you encounter compilation errors, ensure that:

• The JAR file is properly added to your project’s classpath
• You’re using Java 1.7 or higher
• Your IDE has properly indexed the library

Dependencies

The Rave Java Library includes the following dependencies (automatically managed if using Maven):

• Apache HttpClient for HTTP communication
• JSON library for data parsing
• SLF4J for logging

These dependencies are bundled in the JAR file, so you don’t need to install them separately.

Next steps

Configuration

Configure your API keys and environment settings

Quickstart

Process your first payment with a step-by-step guide