Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tutosrive/ferreandina-nosql/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through running the complete Ferreandina NoSQL stack on your local machine — the Java/Javalin REST API listening on port 7070 and the React frontend served by Vite on port 5173. By the end you will have both tiers running, connected to a local (or Atlas) MongoDB instance, and be able to make your first API call.

​
Prerequisites

Make sure the following tools are installed and available on your PATH before proceeding:
  • Java 21+ — required by the Gradle toolchain configuration in build.gradle.kts
  • Gradle — or simply use the included gradlew wrapper (no separate install needed)
  • Node.js 18+ — required by Vite and the frontend toolchain
  • pnpm — the frontend package manager used by the project (npm install -g pnpm)
  • MongoDB 6+ — a local mongod instance or a free MongoDB Atlas cluster

​
Setup Steps

1

Clone the repository

Download the project source from GitHub and navigate into the root directory.
git clone https://github.com/tutosrive/ferreandina-nosql.git
cd ferreandina-nosql
2

Configure the backend

The backend reads its database connection details from a .env file located at app/bc/.env, loaded at runtime by dotenv-java inside Connection.java.Create the file with your MongoDB connection string and database name:
MONGODB_URI=mongodb://localhost:27017
MONGODB_DB_NAME=ferreandina
MONGODB_URI is passed directly to MongoClients.create() and MONGODB_DB_NAME selects the target database. If you are using MongoDB Atlas, replace MONGODB_URI with your full Atlas connection string (e.g. mongodb+srv://user:pass@cluster.mongodb.net).
3

Start the backend

Use the Gradle wrapper to compile and run the API server. The first build will download all dependencies automatically.
cd app/bc
./gradlew run
The Javalin server starts on port 7070 as configured in App.java:
Javalin.create(config -> {
    new Routes(config);
    config.bundledPlugins.enableCors(cors -> {
        cors.addRule(it -> { it.anyHost(); });
    });
}).start(7070);
You should see Javalin’s startup log followed by the MongoDB URI and database name echoed to the console.
4

Configure the frontend

The React app uses an Axios instance whose baseURL is read from the VITE_API_URL environment variable. Create app/fr/.env pointing at the running backend:
VITE_API_URL=http://localhost:7070/
If VITE_API_URL is not set, axios.config.ts falls back to http://localhost:8080/, so setting this variable explicitly is recommended.
5

Start the frontend

Install dependencies with pnpm and launch the Vite development server from the app/fr directory.
cd app/fr
pnpm install
pnpm dev
Vite will start the development server and print a local URL — by default http://localhost:5173. Open that address in your browser to access the Ferreandina UI.
6

Verify the API is running

With the backend running, send a request to the branches endpoint to confirm everything is wired up correctly:
curl http://localhost:7070/api/branches
You should receive a JSON array in response. An empty array ([]) is expected if the database has no data yet — see the Seed Data section below to populate it.

​
Seed Data

The config/collections/ directory contains JSON seed documents for all nine MongoDB collections:
FileCollection
branches.jsonbranches
categories.jsoncategories
customers.jsoncustomers
invoice.jsoninvoice
price_changes.jsonprice_changes
products.jsonproducts
suppliers.jsonsuppliers
supplies.jsonsupplies
workers.jsonworkers
Use mongoimport to load any collection into your local database. For example, to import the products collection: 
mongoimport --uri "mongodb://localhost:27017/ferreandina" \
  --collection products \
  --file config/collections/products.json \
  --jsonArray
Repeat the command for each file, replacing products with the relevant collection name. Run these commands from the repository root so the relative file paths resolve correctly.
The repository root contains Ferreandina-Bruno-Requests.zip — a Bruno request collection with pre-built requests for every API endpoint. Import it into Bruno to explore and test all routes (branches, categories, products, suppliers, supplies, customers, and workers) without writing any curl commands.

Build docs developers (and LLMs) love

Get started for freeTalk to us