Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Bran258/drtc-fluvial-admin/llms.txt

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

This guide walks you through setting up DRTC Fluvial Admin on your local machine. By the end, you will have the Next.js 16 admin panel running at http://localhost:3000 and connected to your NestJS backend.
DRTC Fluvial Admin requires a running NestJS backend. The admin panel proxies all API requests through NEXT_PUBLIC_API_URL. Make sure your backend is reachable before you start.
1

Check prerequisites

Before you begin, verify that the following tools are installed on your machine:
  • Node.js 18 or later — run node -v to check your version
  • pnpm — the project uses pnpm as its package manager
If pnpm is not installed, add it with:
npm install -g pnpm
2

Clone the repository

Clone the drtc-fluvial-admin repository and move into the project directory:
git clone https://github.com/Bran258/drtc-fluvial-admin.git
cd drtc-fluvial-admin
3

Install dependencies

Install the project dependencies using pnpm:
pnpm install
4

Configure environment variables

Create a .env.local file in the project root and set the URL of your NestJS backend:
.env.local
NEXT_PUBLIC_API_URL=http://localhost:3001
The admin panel uses this variable to forward all /api/* requests to your backend at /api/v1/*. Replace http://localhost:3001 with the actual address of your backend server.
5

Start the development server

Run the development server:
pnpm dev
Open http://localhost:3000 in your browser. The root path (/) automatically redirects you to /auth, where you can sign in with your institutional credentials.

Next steps

Authentication

Learn how login, token refresh, and session management work

Dashboard

Explore the real-time statistics and operations overview

Vessel registration

Start the empadronamiento workflow for river vessels

Environment configuration

Full reference for all environment variables and deployment options

Build docs developers (and LLMs) love