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.

Ferreandina NoSQL is a complete hardware store management system built as a university project at UCALDAS. It combines a Java 21 + Javalin 7 REST API backed by MongoDB with a React + TypeScript single-page frontend. The system covers the full lifecycle of a hardware business — from managing product catalogs and supplier relationships to tracking branch inventory and customer records.

Introduction

Understand what Ferreandina NoSQL is, how it’s structured, and what it does

Quickstart

Get the backend API and frontend running locally in under 10 minutes

Architecture

Explore the two-tier architecture and MongoDB data model

API Reference

Browse all REST endpoints, request bodies, and response shapes

What’s Inside

Backend API

Java 21 + Javalin 7 REST server with MongoDB driver. Generic controller pattern for zero-boilerplate CRUD on every resource.

React Frontend

Vite + React 18 + TypeScript dashboard with PrimeReact components, Tailwind CSS, and React Router.

Advanced Queries

MongoDB aggregation pipelines for low-stock alerts, defective supply reports, and branch product management.

Quick Look

1

Start MongoDB

Make sure a MongoDB instance is running locally or provide a connection URI via environment variables.
2

Run the backend

Navigate to app/bc, create a .env file with your MongoDB credentials, then run ./gradlew run. The API starts on port 7070.
3

Run the frontend

Navigate to app/fr, set VITE_API_URL in .env, then run pnpm dev. The dashboard opens on port 5173.
4

Explore the API

Hit http://localhost:7070/api/branches to verify the backend is responding, then explore the full API Reference.

Build docs developers (and LLMs) love