Getting Started

This guide walks you through the initial setup to run the Envia Admin platform locally.

Prerequisites

Requirement	Version
Node.js	18.x (backend) / 22.x (frontend)
npm	10.x+
PHP	8.1+ with Composer
MySQL	5.7+ or 8.x
Redis	6.x+

TIP

Use nvm to manage multiple Node.js versions across the monorepo projects.

Clone the Repository

git clone <repository-url>
cd admon-monorepo

Backend Setup

cd backend
cp .env.example .env   # configure your environment variables
npm install
npm run dev             # starts the API with nodemon

The API starts on the port defined in your .env file.

Frontend Setup

Vue Client

cd frontend
npm install
npm run dev             # starts the Vite dev server

PHP Server

cd frontend
composer install
php spark serve         # starts the CodeIgniter dev server

Available Scripts

Backend

Script	Description
npm run dev	Start the API in development mode (nodemon)
npm test --directory=<folder>	Run tests for a specific directory
npm run lint	Check code style with ESLint
npm run lint:fix	Auto-fix ESLint issues
npm run format	Check formatting with Prettier
npm run format:fix	Auto-format with Prettier

Frontend

Script	Description
npm run dev	Start the Vue app with Vite
npm run build	Build the Vue app for production
npm run preview	Preview the production build locally
npm run lint	Check code style with ESLint
npm run lint:fix	Auto-fix ESLint issues
npm run format	Check formatting with Prettier
npm run format:fix	Auto-format with Prettier

Next Steps

Once the platform is running locally, explore the Technical Architecture to understand the codebase structure.