Skip to content

Latest commit

 

History

79 Commits

Folders and files

Repository files navigation

openfront-construction

Deploy with Vercel

Deploy on Railway

Openfront Construction is a self-hostable construction project and company-operations application. Prospective clients can explore services and request work, while project participants use scoped portal access. Teams manage preconstruction, contracts, budgets, procurement, execution, field records, documents, safety, billing, and approvals.

Documentation: docs.openship.org/docs/openfront/construction

Demo

Storefront construction.openship.org
Dashboard construction.openship.org/dashboard

Learn more →

Documentation →

The Openfront Ecosystem

Every Openfront is open source and self-hostable. Try any of them on its live demo.

Product For Repository Demo Docs
Openfront E-commerce Online store: catalog, checkout, orders, fulfillment openfront e-commerce.openship.org Docs
Openfront Restaurant Online ordering, POS and kitchen display openfront-restaurant restaurant.openship.org Docs
Openfront Grocery Grocery ordering, lots, expiry and pickup openfront-grocery grocery.openship.org Docs
Openfront Gym Memberships, classes, check-in and billing openfront-gym gym.openship.org Docs
Openfront Hotel Reservations, front desk, housekeeping, folios openfront-hotel hotel.openship.org Docs
Openfront Rental Short-term rental bookings and calendars openfront-rental rental.openship.org Docs
Openfront Salon Appointments, stylists and services openfront-salon salon.openship.org Docs
Openfront Barbershop Bookings, walk-ins and barbers openfront-barbershop barbershop.openship.org Docs
Openfront Coffee Shop Café ordering and counter POS openfront-coffeeshop coffee-shop.openship.org Docs
Openfront Real Estate Listings, showings and transactions openfront-realestate real-estate.openship.org Docs
Openfront Dealership Inventory, test drives, deals and service openfront-dealership dealership.openship.org Docs
Openfront Vape Age-gated retail with compliance controls openfront-vape vape.openship.org Docs
Openfront Convenience Convenience store POS and inventory openfront-convenience convenience.openship.org Docs
Openfront Collectibles Graded items, consignment and provenance openfront-collectibles collectibles.openship.org Docs
Openfront Cannabis Dispensary menu, packages and recalls openfront-cannabis cannabis.openship.org Docs
Openfront Pharmacy Prescriptions, inventory lots and pickup openfront-pharmacy pharmacy.openship.org Docs
Openfront Med Spa Treatments, consents and memberships openfront-medspa medspa.openship.org Docs
Openfront Construction (this repository) Projects, bids, change orders and crews openfront-construction construction.openship.org Docs
Openfront Law Firm Matters, intake, time and billing openfront-law-firm law-firm.openship.org Docs
Openfront Scheduling Booking pages for appointment businesses openfront-scheduling scheduling.openship.org Docs
Openfront Social Creator community and posts openfront-social social.openship.org Docs
Openfront Rideshare Rides, drivers and dispatch openfront-rideshare rideshare.openship.org Docs
Openfront Airline Flights, booking and passenger operations openfront-airline airline.openship.org Docs
Openfront Hospital Appointments, patients and care teams openfront-hospital hospital.openship.org Docs
Openfront Sportsbook Markets, bets and results openfront-sportsbook sportsbook.openship.org Docs
Openfront Financial Accounts, portfolios and advisory openfront-financial financial.openship.org Docs
Openfront Analytics Privacy-friendly website analytics analytics analytics.openship.org Docs
Openship Order routing from sales channels to fulfillment openship os.openship.org Docs
Marketplace Shop across Openfront stores marketplace marketplace.openship.org Docs

Core Features

Admin Dashboard

Manage pipeline, projects, store settings, setup, service requests, portfolio through dedicated dashboard workspaces and permission-controlled data screens.

Storefront

Public routes cover services, project portfolios, /start-a-project, estimates, bids, RFPs, and customer request accounts. The /portal surface provides project-specific collaboration rather than unrestricted dashboard access.

Project Workspaces

Organize project teams, schedules, preconstruction, contracts, financials, procurement, execution, field activity, and reporting.

Documents & Controlled Approvals

Manage documents, invitations, approval policies and decisions, project records, and participant portal workflows.

Client Requests & Delivery

Capture public intake and service requests, expose customer request status, and route workflow events through an outbox. Payment or webhook configuration must be supplied separately from the project record itself.

Architecture

Technology Stack

  • Frontend: Next.js 16 with App Router and React 19.
  • Backend: KeystoneJS 6 with a GraphQL API.
  • Database: PostgreSQL with Prisma ORM.
  • Styling: Tailwind CSS 4 and shared shadcn/ui components.
  • Authentication: Password-based user accounts and session-based access with role capabilities.

Application Structure

openfront-construction/
├── app/                    # Public pages, dashboard routes, and HTTP endpoints
├── features/
│   ├── keystone/           # Backend models, access rules, and GraphQL workflows
│   ├── platform/           # Operator workspaces and onboarding
│   ├── storefront/         # Public application components and screens
│   └── dashboard/          # Authentication and shared dashboard shell
└── components/             # Shared UI components

Data Models

The model registry and Prisma schema cover:

  • Companies, memberships, projects, contacts, leads, and public service requests.
  • Preconstruction, contracts, financials, procurement, resources, and execution records.
  • Documents, field operations, quality and safety records, billing, and approvals.
  • Portal invitations, API credentials, agent actions, governance, and outbox records.

Getting Started

Prerequisites

  • Node.js 22, compatible with the package requirements and Next.js 16.
  • A PostgreSQL database you can migrate.
  • npm.

Setup

  1. Clone and install dependencies:

    git clone https://github.com/openshiporg/openfront-construction.git
    cd openfront-construction
    npm install
  2. Configure environment variables:

    cp .env.example .env

    Review the example configuration and replace its placeholders. Keep only the local settings you need; do not copy production-mode or infrastructure examples unchanged.

    DATABASE_URL=postgresql://user:password@host/database
    SESSION_SECRET=replace-with-a-new-private-random-secret

    Generate the session secret with openssl rand -hex 32; use the generated value, not the placeholder. Never commit .env.

    Review runtime configuration for additional application settings before building or deploying. Configure enabled integrations separately; the two values above are not a complete production configuration.

  3. Start development server:

    npm run dev

    The development script prepares the backend schema, applies checked-in migrations, and starts Next.js.

  4. Access the application: Open the URL npm run dev prints, then use these paths:

    • Public application: /
    • Admin dashboard: /dashboard
    • Customer account: /account
    • GraphQL API: /api/graphql
  5. Create your first admin user: Visit /dashboard/init on an empty database to create the initial administrator, then sign in to the dashboard.

  6. Run application onboarding: Run workspace onboarding, establish company and project memberships, and configure public services, project templates, portal invitations, and approval policies.

Development Commands

  • npm run dev - Prepare the backend schema, apply migrations, and start Next.js development.
  • npm run build - Build the backend and Next.js for production; does not apply migrations.
  • npm start - Start the production Next.js server.
  • npm run migrate:gen - Prepare the schema and generate/apply development migrations.
  • npm run migrate - Apply checked-in Prisma migrations.
  • npm run lint - Run the repository's ESLint script.
  • npm run typecheck - Run the configured TypeScript check.
  • npm run test - Run the repository's configured test suite.
  • npm run outbox:work - Drain a bounded batch of configured webhook deliveries.

Use a disposable development database for migration generation. Review the script before running it against any existing data.

Project Workflow Integration

The command registry exposes project lifecycle, documents, approvals, portal access, and credentials. Use npm run outbox:work for the repository's outbox entry point when delivery is configured.

Documentation

See the Openfront Construction documentation for the application guide. The backend models, registered business workflows, access rules, and application routes document the implementation in this repository.

Security & Permissions

Role-Based Access Control

  • canAccessDashboard - Access dashboard.
  • canManageProjects - Manage projects.
  • canManagePreconstruction - Manage preconstruction.
  • canManageContracts - Manage contracts.
  • canManageDocuments - Manage documents.
  • canManageBilling - Manage billing.

Security Features

  • Session-based authentication for signed-in users.
  • Backend list access and workflow authorization, rather than dashboard visibility alone.
  • Company and project membership filters combine with area-specific read/manage permissions. API credentials are further restricted to their company, optional project, and scopes; portal access follows separate participant grants.

Review the access implementation and individual workflow checks before extending permissions.

Platform Components

Admin Platform (/dashboard)

  • Pipeline: /dashboard/platform/pipeline.
  • Projects: /dashboard/platform/projects.
  • Store Settings: /dashboard/platform/store-settings.
  • Setup: /dashboard/platform/setup.
  • Service Requests: /dashboard/platform/service-requests.
  • Portfolio: /dashboard/platform/portfolio.

Storefront Experience

Public routes cover services, project portfolios, /start-a-project, estimates, bids, RFPs, and customer request accounts. The /portal surface provides project-specific collaboration rather than unrestricted dashboard access.

Organize project teams, schedules, preconstruction, contracts, financials, procurement, execution, field activity, and reporting.

Deployment

Production Deployment

The Vercel button imports this application's own repository. Provision PostgreSQL and configure the application's complete runtime requirements, storage, mail, and enabled providers before building. Importing the source does not configure these services.

Build the application and apply checked-in migrations as a release step before starting the server. Back up existing data before migration.

npm run build
npm run migrate
npm start

The included Railway configuration defines this app's build and startup lifecycle. Provision services and secrets separately.

Scaling Considerations

Schedule npm run outbox:work to drain configured webhook delivery batches. Retain company/project scope and shared document storage across processes.

Contributing

Use the development commands above when preparing changes. Keep model changes and their migrations together, and describe workflow and permission changes in pull requests.

License

This project is licensed under the MIT License. See LICENSE.

Support


Built with Next.js and KeystoneJS.