Getting Started

Everything a new user needs to download, install, and run NioFlow quickly.

Download Options

Maven Users (recommended)

Maven gives dependency management, reproducible builds, and easiest upgrades.

pom.xml

1<dependency>
2  <groupId>com.jhanvi857</groupId>
3  <artifactId>nioflow-framework</artifactId>
4  <version>1.0.0</version>
5</dependency>

Without Maven

Download nioflow-framework-1.0.0.jar and checksum from GitHub Releases.

manual-jar

1# Linux/macOS
2javac -cp nioflow-framework-1.0.0.jar App.java
3java -cp nioflow-framework-1.0.0.jar:. App
4
5# Windows PowerShell
6javac -cp .\nioflow-framework-1.0.0.jar App.java
7java -cp .\nioflow-framework-1.0.0.jar;. App

Setup Your First App

App.java

1import com.jhanvi857.nioflow.NioFlowApp;
2import com.jhanvi857.nioflow.protocol.HttpStatus;
3
4public class App {
5    public static void main(String[] args) {
6        NioFlowApp app = new NioFlowApp();
7
8        app.get("/", ctx -> ctx.send("NioFlow is running"));
9        app.get("/_health", ctx -> ctx.status(HttpStatus.OK).json(java.util.Map.of("status", "UP")));
10
11        app.listen(8080);
12    }
13}

Port Registration

In cloud providers, use PORT env var. In local, default to 8080.

port-config

1int port = 8080;
2String value = System.getenv("PORT");
3if (value != null && !value.isBlank()) {
4    port = Integer.parseInt(value);
5}
6app.listen(port);

Suggested Layout

project-structure

1my-app/
2  src/main/java/com/example/
3    App.java
4    controller/
5      TaskController.java
6    auth/
7      AuthController.java
8    repository/
9      TaskRepository.java
10    model/
11      Task.java
12  src/main/resources/public/
13    index.html
14  pom.xml