Quickstart Guide

Overview

This guide will walk you through the essential steps to start using Core Projects, from logging in to exploring your first project and creating your first client record.

This guide assumes Core Projects is already installed and configured. If you need installation instructions, see the Installation & Setup guide.

Getting Started

Access the Login Page

Navigate to your Core Projects installation URL. You’ll be directed to the employee login page.Route: / (routes/web.php:50)The login page requires:

Email address
Password

Employees must be created by an Administrator before they can log in. There is no self-registration.

Enter your credentials provided by your system administrator.Authentication Flow:

Credentials are validated against the empleados table (app/Models/Empleado.php:1-65)
Successful login redirects you to your role-appropriate dashboard
Login activity is tracked in the system logs

If you’ve forgotten your password, use the “Forgot Password” link at /empleado/forgot-password to receive a password reset email.

Explore Your Dashboard

Upon successful login, you’ll be redirected to your dashboard based on your role:

Manager/Administrator Dashboard

Route: /dashboard (routes/web.php:63)The main dashboard displays:

Active projects overview
Recent sales activity
Property availability statistics
Quick access to key modules

Sales Dashboard

Sales team members have access to:

Catalog: Browse available properties at /catalogo (routes/web.php:243)
Client Management: View and manage clients at /clientes (routes/web.php:269)
Sales: Process sales and reservations at /ventas (routes/web.php:322)
Quote Generator: Create quotes at /cotizador (routes/web.php:398)
Sales Targets: Monitor goals at /metas (routes/web.php:409)

Management Dashboard

Route: /gerencia/dashboard (routes/web.php:415)Executives access:

Comprehensive sales analytics
Team performance metrics
Financial reports
Sales target management

Accounting Dashboard

Route: /contabilidad/ventas (routes/web.php:452)Accounting staff can:

Review all sales transactions
Access payment plans
Export financial reports
Generate consolidation reports

Navigate to Projects

For Administrators/Managers:Access the projects module to view all construction projects:Route: /proyectos (routes/web.php:66)From here you can:

View all active and inactive projects
See project details including location, budget, and timeline
Access project configuration options
Manage towers, floors, and property inventory

Click on any project to view its details:Route: /proyectos/{proyecto} (routes/web.php:69)Project information includes:

Basic details (name, description, dates)
Budget tracking (initial and final)
Construction metrics (square meters, floors, towers)
Property inventory counts
Status and location
Pricing policies

Create Your First Client (Sales Users)

For Sales Team Members:Navigate to the clients section to create a new client record:Route: /clientes/create (routes/web.php:270)

// From app/Models/Cliente.php:16-24
[
  'nombre',                // Client name
  'id_tipo_cliente',       // Client type (individual, company, etc.)
  'id_tipo_documento',     // Document type (ID, passport, etc.)
  'documento',             // Document number (primary key)
  'direccion',             // Address
  'telefono',              // Phone number
  'correo',                // Email address
]

Required Information:

Client Type: Select from predefined client types
Document Type: Choose document type (ID, passport, tax ID, etc.)
Document Number: Enter the client’s unique identification number
Name: Full name or company name
Contact Details: Address, phone, and email

The document number serves as the unique identifier for each client in the system.

After creating a client, you can:

View their complete profile at /clientes/{documento}
See their purchase history
Process new sales for them

Explore the Property Catalog

Route: /catalogo (routes/web.php:243)The catalog displays all available properties across your projects:

Apartments: Residential units with type, floor, and tower information
Commercial Spaces: Retail or office units
Parking Spaces: Vehicle and motorcycle parking

Property Details

Click any property to view detailed information:Route: /catalogo/{tipo}/{id} (routes/web.php:244)Property details include:

Location (project, tower, floor)
Specifications (area, type, features)
Current status (available, reserved, sold)
Base price and total price
Associated parking or amenities

Interactive Simulator

Use the pricing simulator to calculate payment scenarios:Route: /catalogo/simulador/{tipo}/{id} (routes/web.php:400)Simulate different scenarios:

Down payment amounts
Installment terms
Payment schedules
Total cost calculations

Process Your First Sale or Reservation

Route: /ventas/create (routes/web.php:324)Core Projects supports two types of transactions:

1. Separación (Reservation)

A temporary hold on a property:

Requires a separation fee (configurable per project)
Has an expiration date (auto-calculated based on project settings)
Can be converted to a full sale later
Automatically expires if not converted

Code Reference:

// From app/Models/Venta.php:15-16
const TIPO_VENTA = 'venta';
const TIPO_SEPARACION = 'separacion';

2. Venta (Sale)

A completed property sale:

Select client from database
Choose property (apartment, commercial space, or parking)
Configure payment terms
Set down payment amount
Define installment schedule
Generate amortization plan

// From app/Models/Venta.php:18-43
[
  'id_empleado',                    // Sales representative
  'documento_cliente',              // Client document number
  'fecha_venta',                    // Sale date
  'id_apartamento',                 // Apartment ID (if applicable)
  'id_local',                       // Commercial space ID (if applicable)
  'id_parqueadero',                 // Parking ID (if applicable)
  'id_proyecto',                    // Project
  'id_forma_pago',                  // Payment method
  'valor_base',                     // Base price
  'iva',                            // Tax
  'valor_total',                    // Total price
  'cuota_inicial',                  // Down payment
  'valor_restante',                 // Remaining balance
  'plazo_cuota_inicial_meses',      // Down payment term (months)
  'tipo_operacion',                 // 'venta' or 'separacion'
  // ... and more fields
]

After creating a sale, the system:

Updates property status
Links sale to client record
Generates payment plan (if applicable)
Creates amortization schedule

Converting a Reservation to Sale

Route: /ventas/{id}/convertir (routes/web.php:403)Convert a reservation to a full sale by:

Accessing the reservation details
Clicking “Convert to Sale”
Completing payment plan configuration
Finalizing the sale

Reservations that exceed their expiration date are automatically marked as expired and the property becomes available again.

Generate Payment Plans

Route: /plan-amortizacion-venta (routes/web.php:357)For sales with installment payments:

Select Client: Choose from clients with active sales
Select Sale: Pick the specific sale transaction
Generate Plan: System automatically creates payment schedule

Route: /plan-amortizacion-venta/generar (routes/web.php:368)The amortization plan includes:

Payment number and due dates
Principal and interest breakdown
Running balance
Payment status tracking

Export Payment Plan

Route: /plan-amortizacion-venta/exportar (routes/web.php:372)Generate PDF reports for:

Client records
Accounting purposes
Financial institution requirements

Record Payments

Route: /pagos/create (routes/web.php:379)Track incoming payments:

Link to Sale: Associate payment with specific sale
Payment Details:
- Payment date
- Amount
- Payment method
- Payment concept
- Reference number
Apply to Schedule: Update amortization plan automatically

The system:

Updates payment plan status
Tracks remaining balance
Marks paid installments
Calculates outstanding amounts

Common Workflows

For Sales Team

Daily Workflow:
- Check catalog for available properties
- Follow up on active reservations
- Process new sales
- Record incoming payments
- Generate quotes for prospects
Monthly Tasks:
- Review sales targets at /metas
- Check pending payments
- Update client information
- Generate sales reports

For Administrators

Setup Tasks:
- Create and configure projects
- Set up property inventory (towers, floors, units)
- Define pricing policies
- Manage employee accounts
Ongoing Management:
- Monitor project progress
- Review sales activity at /admin/ventas
- Manage client database at /admin/clientes
- Update property status

For Management

Strategic Oversight:
- Review executive dashboard
- Set sales targets
- Analyze performance metrics
- Export consolidated reports

Quick Reference: Key Routes

// Main Areas (from routes/web.php)

// Authentication
GET  /                           // Login page
POST /login                      // Submit login
POST /logout                     // Sign out

// Dashboards
GET  /dashboard                  // Admin dashboard
GET  /gerencia/dashboard         // Management dashboard
GET  /contabilidad/ventas        // Accounting dashboard

// Projects (Admin/Manager)
GET  /proyectos                  // List projects
GET  /proyectos/{id}             // View project
GET  /admin/torres               // Manage towers
GET  /apartamentos               // Manage apartments

// Sales Module
GET  /catalogo                   // Property catalog
GET  /clientes                   // Client list
GET  /clientes/create            // New client
GET  /ventas                     // Sales list
GET  /ventas/create              // New sale
GET  /cotizador                  // Quote generator
GET  /metas                      // Sales targets

// Payments
GET  /pagos                      // Payment list
GET  /pagos/create               // Record payment
GET  /plan-amortizacion-venta    // Amortization plans

Next Steps

Now that you’re familiar with the basics:

Configure Your First Project

Set up a new construction project with towers, floors, and property units

Manage Sales Team

Create employee accounts and assign roles for your sales team

Set Up Pricing Policies

Configure project-specific pricing rules and discounts

Export Reports

Generate financial reports and integrate with accounting systems

Need Help?

If you encounter issues:

Check the login logs at /admin/login-logs (routes/web.php:234)
Contact your system administrator
Review project and property configurations
Verify user role permissions

Get Started

Core Concepts

Features

User Guides

Overview

Getting Started

Manager/Administrator Dashboard

Sales Dashboard

Management Dashboard

Accounting Dashboard

Required Information:

Property Details

Interactive Simulator

1. Separación (Reservation)

2. Venta (Sale)

Converting a Reservation to Sale

Export Payment Plan

Common Workflows

For Sales Team

For Administrators

For Management

Quick Reference: Key Routes

Next Steps

Configure Your First Project

Manage Sales Team

Set Up Pricing Policies

Export Reports

Need Help?

Build docs developers (and LLMs) love

Get Started

Core Concepts

Features

User Guides

​Overview

​Getting Started

​Manager/Administrator Dashboard

​Sales Dashboard

​Management Dashboard

​Accounting Dashboard

​Required Information:

​Property Details

​Interactive Simulator

​1. Separación (Reservation)

​2. Venta (Sale)

​Converting a Reservation to Sale

​Export Payment Plan

​Common Workflows

​For Sales Team

​For Administrators

​For Management

​Quick Reference: Key Routes

​Next Steps

Configure Your First Project

Manage Sales Team

Set Up Pricing Policies

Export Reports

​Need Help?

Build docs developers (and LLMs) love

Overview

Getting Started

Manager/Administrator Dashboard

Sales Dashboard

Management Dashboard

Accounting Dashboard

Required Information:

Property Details

Interactive Simulator

1. Separación (Reservation)

2. Venta (Sale)

Converting a Reservation to Sale

Export Payment Plan

Common Workflows

For Sales Team

For Administrators

For Management

Quick Reference: Key Routes

Next Steps

Need Help?