Getting Started

Welcome to ProposalAI — the AI-powered proposal and contract generation platform. This documentation will guide you through everything you need to know.

Quick Start

  1. Register your account at https://www.naasproposal.naas-emart.com/register
  2. Set up your workspace in Settings → Branding
  3. Add your first client in the Clients section
  4. Create a proposal using AI generation
  5. Send the proposal link to your client for signing

Installation

To self-host ProposalAI on your own server, use the guided installer at /install.

Requirements: PHP ≥ 8.2, MySQL 8+, Composer, Node.js 18+
git clone https://github.com/your-repo/proposalai.git
cd proposalai
composer install --no-dev
npm install && npm run build
cp .env.example .env
php artisan key:generate
# Visit /install to complete setup

Dashboard

The dashboard provides an overview of your proposal activity including stats, recent proposals, and a 6-month chart of proposal volume.

  • Total proposals sent, signed, viewed and pending
  • Monthly proposal chart (Chart.js)
  • Quick action buttons for creating proposals and managing clients

Creating Proposals

Navigate to Proposals → New Proposal to create your first proposal. Fill in:

  • Title – The proposal title visible to your client
  • Client – Select from your client list or enter details manually
  • Sections – Drag to reorder, rename, add, or delete sections
  • Pricing – Set total amount, deposit, currency, and tax rate
  • Validity – Optional expiry date for the proposal link
Tip: Use the AI Generate button to automatically populate sections based on a brief description of the project.

AI Generation

ProposalAI uses OpenAI GPT to generate professional proposal sections. Set your OpenAI API key in Admin → Settings.

  1. Open a proposal for editing
  2. Click Generate with AI and describe the project
  3. Choose the type of proposal (web design, consulting, etc.)
  4. AI generates all standard sections automatically
  5. Edit individual sections or regenerate any section

Managing Clients

The Clients section stores your client contacts for reuse across proposals. Each client has a name, email, and company.

Settings

Configure your workspace under Settings:

  • Branding – Logo, brand name, accent color for proposals
  • Team – Invite team members to your workspace
  • Profile – Update your name, email, and password

Billing & Plans

Plans are managed by the super admin. Visit the Pricing page to view available plans. Stripe integration supports online payments.

API

ProposalAI does not yet expose a public REST API. The internal endpoints used by the UI are protected by CSRF tokens and session authentication.

FAQ

Yes. The public proposal view is fully responsive. Clients can draw or type their signature on any device.
Each time a client opens the proposal link, a view is recorded with time-on-page and scroll depth per section.
Yes. Point your domain to the server and update APP_URL in your .env file.
All data is stored in your own MySQL database. Passwords are hashed with bcrypt. Use HTTPS in production.
Delete the storage/installed.lock file and visit /install again. Note: this does not delete existing data.