Run or Build

This section explains how to build FastExcel from source code.

Development environment

To develop FastExcel, you need Maven 3.8.1 or above and JDK (Java Development Kit) 17 or above. Currently, it is recommended to use Maven 3.9.0 or above and Java 21 or above for the development environment. However, you must use Java 1.8 compatible language features during compilation to ensure FastExcel can run in environments with Java 1.8 or above.

You can use tools such as SDKMAN to configure multiple versions of the Java toolchain.

IDEA Settings

The following guidelines are for development using IntelliJ IDEA. Other versions may have some minor differences. Please follow all steps carefully.

Project Settings

Set the project Language Level to 8 to ensure backward compatibility.

Git Usage

Ensure that you have registered a GitHub account and follow the steps below to configure your local development environment:

Fork the repository: Click the Fork button on the FastExcel GitHub page to copy the project to your GitHub account.

https://github.com/<your-username>/fastexcel

Clone Repository: Run the following command to clone the forked project to your local machine:

git clone git@github.com:<your-username>/fastexcel.git

Set Upstream Repository: Set the official repository as upstream for easy synchronization of updates:

git remote add upstream git@github.com:fast-excel/fastexcel.git
git remote set-url --push upstream no-pushing

Running git remote -v can verify if the configuration is correct.

Compilation

Run the following command to compile

mvn clean install -DskipTests

To speed up the build process, you can:

• Use -DskipTests to skip unit tests
• Use Maven's parallel build feature, e.g., mvn clean install -DskipTests -T 1C

Code Style

FastExcel uses Spotless as its code formatting tool. Please ensure you run the following command to automatically format your code before submitting:

mvn spotless:apply