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 covers everything needed for productive local development on Directorio UDC. It goes beyond a basic quickstart to include editor setup, code-quality tooling, and the correct workflow for running the React frontend and the Express backend together in parallel.

​
Prerequisites

Before you begin, make sure the following are installed on your machine:
  • Node.js 18 or higher — nodejs.org/en/download
  • npm 9 or higher — bundled with Node.js; verify with npm --version
  • Git — git-scm.com
  • A code editor — VS Code is recommended for first-class TypeScript and Vite support

​
Clone and Install

1

Clone the repository

Clone the project from GitHub and move into the project root:
git clone https://github.com/Minogar28/DIRECTORIO_UDC.git && cd DIRECTORIO_UDC
2

Install backend dependencies

Navigate into the BACKEND directory and install its Node.js dependencies:
cd BACKEND && npm install
This installs Express 5, cors, and the path module listed in BACKEND/package.json.
3

Install frontend dependencies

Move into the FRONTEND directory and install its dependencies:
cd ../FRONTEND && npm install
This installs React 19, Vite 8, TypeScript 6, ESLint 10, and all associated plugins and type definitions listed in FRONTEND/package.json.

​
Running Both Services

The frontend (Vite dev server) and backend (Express) are separate Node.js processes and must each run in their own terminal window. Open two terminals side-by-side, then start each service:
Start the Express server from the BACKEND directory:
cd BACKEND && node index.js
By default the server listens on port 3000. You can override this with the PORT environment variable — see the Environment guide for details.
With both processes running you can open the URL Vite prints in your browser. Changes to any src/ file are reflected instantly without a full page reload, thanks to Vite’s HMR engine.

​
ESLint

The frontend uses ESLint 10 configured in FRONTEND/eslint.config.js. The config extends:
  • @eslint/js recommended rules
  • typescript-eslint recommended rules
  • eslint-plugin-react-hooks — enforces the Rules of Hooks
  • eslint-plugin-react-refresh — warns when component exports are incompatible with fast-refresh
Run the linter at any time with: 
cd FRONTEND && npm run lint
The dist/ output folder is ignored by ESLint via the globalIgnores call in the config, so only source files are checked.

​
TypeScript Checking

TypeScript type-checking is bundled into the production build step — npm run build runs tsc -b before handing control to Vite: 
# Full build (type-check + bundle)
cd FRONTEND && npm run build
If you want to check types without producing a bundle — for example, in a pre-commit hook or CI pipeline — run tsc in --noEmit mode: 
cd FRONTEND && npx tsc --noEmit
The TypeScript compiler is configured in FRONTEND/tsconfig.app.json with strict settings including noUnusedLocals, noUnusedParameters, and noFallthroughCasesInSwitch, targeting ES2023 output.
Install the official Vite (antfu.vite) and ESLint (dbaeumer.vscode-eslint) VS Code extensions for the best developer experience: in-editor error highlighting, auto-imports, and format-on-save support come out of the box with no extra configuration.

Build docs developers (and LLMs) love

Get started for freeTalk to us