Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Minogar28/DIRECTORIO_UDC/llms.txt

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

This guide walks you through every step needed to get a local instance of Directorio UDC running on your machine. By the end you will have the Express backend process started and the Vite development server hosting the React frontend.
Prerequisites — make sure the following are installed before you begin:
1

Clone the Repository

Download the project source code from GitHub and move into the root directory:
git clone https://github.com/Minogar28/DIRECTORIO_UDC.git
cd DIRECTORIO_UDC
2

Install Backend Dependencies

Navigate to the BACKEND directory and install its dependencies:
cd BACKEND
npm install
This installs the three production packages the API server needs: Express 5 (^5.2.1), cors (^2.8.6), and path (^0.12.7).
3

Install Frontend Dependencies

Move to the FRONTEND directory and install its dependencies:
cd ../FRONTEND
npm install
This installs React 19 (^19.2.5) and react-dom, Vite 8 (^8.0.10), TypeScript (~6.0.2), plus all supporting tooling including @vitejs/plugin-react, the React Compiler Babel preset, ESLint (^10.2.1), and the corresponding type definitions.
4

Start the Backend Server

Return to the BACKEND directory and start the Express server:
cd ../BACKEND
node index.js
Keep this terminal open while you work on the frontend. The backend package defines no custom dev or start script, so node index.js is used directly.
5

Start the Frontend Dev Server

Open a new terminal, navigate to the FRONTEND directory, and run:
cd ../FRONTEND
npm run dev
Vite starts a development server with Hot Module Replacement (HMR) enabled, so changes to any source file are reflected in the browser instantly without a full page reload. The dev server is available at http://localhost:5173 by default.
6

Open the App in Your Browser

With both servers running, open your browser and navigate to:http://localhost:5173Because Directorio UDC is currently a scaffold, you will see the default Vite + React starter template — the counter button and framework logos that ship with a new Vite project. Feature development is ongoing; refer to the Architecture Overview to understand how to extend the app.

Available Frontend Scripts

All scripts are run from the FRONTEND directory with npm run <command>.
CommandDescription
npm run devStart development server with HMR
npm run buildBuild for production (TypeScript compile + Vite bundle)
npm run previewPreview the production build locally
npm run lintRun ESLint on TypeScript/TSX files
Run npm run build in the FRONTEND directory to create an optimized production bundle in the dist/ folder. TypeScript is compiled first via tsc -b, then Vite bundles and tree-shakes the output for maximum performance.

Next Steps

Architecture Overview

Understand how the React frontend and Express backend fit together, how data flows between them, and where to extend each layer.

Development Guide

Configure your local environment for active development, including environment variables, editor setup, and debugging tips.

Build docs developers (and LLMs) love