Quickstart

Get PROVESA Web up and running in minutes

Get your PROVESA Web instance running locally in just a few minutes.

Prerequisites

Before you begin, make sure you have:

• Node.js v20 or higher installed
• A PostgreSQL 15+ database (local or remote)
• pnpm v9+ package manager

If you don’t have pnpm installed, you can install it with npm install -g pnpm

Quick Start

1. Clone the repository

   npm

   git clone https://github.com/ashcroft08/provesa-web.git
   cd provesa-web
   
2. Install dependencies

   npm

   npm install
   
3. Configure environment variables

   Copy the example environment file and edit it with your credentials:

   cp .env.example .env
   

   Edit .env with your database credentials and secrets:

   DATABASE_URL="postgres://user:password@localhost:5432/provesa"
   ORIGIN="http://localhost:5173"
   BETTER_AUTH_SECRET="your-32-character-secret-here"
   GMAIL_USER="[e-mail]"
   GMAIL_APP_PASSWORD="your-app-password"
   

   Generate a secure 32-character secret for BETTER_AUTH_SECRET with high entropy. See Better Auth installation docs for details.

4. Set up the database

   Apply the database schema:

   npm

   npm run db:push
   
5. Seed initial data

   Run the seed scripts to create the admin user and default theme:

   npm

   npm run db:seed
   

   The default admin credentials are configured in your .env file under ADMIN_EMAIL and ADMIN_PASSWORD.

6. Start the development server

   npm

   npm run dev
   

   Your application will be running at http://localhost:5173

Next Steps

Now that you have PROVESA Web running:

• Log in with your admin credentials at /login
• Explore the admin panel to manage candidates, suggestions, and site configuration
• Customize the theme colors from the admin panel
• Review the Installation guide for detailed configuration options

For production deployment, make sure to run npm run build or pnpm build to create an optimized production build.