Skip to content

Local-Setup-Guide.md

Latest commit

 

History

History
195 lines (119 loc) · 2.59 KB

Local-Setup-Guide.md

File metadata and controls

195 lines (119 loc) · 2.59 KB
Raw

Livereview Local Setup

1. Set Up a Local PostgreSQL Database

Create a PostgreSQL database for local development.

Create the Database

CREATE DATABASE livereview;

Define the Database URL

You will need a DATABASE_URL for connecting the application to your local PostgreSQL.

Example:

DATABASE_URL=postgres://postgres:password@localhost:5432/livereview?sslmode=disable
  • postgres → database username
  • password → database password
  • localhost:5432 → local PostgreSQL host and port
  • livereview → database name
  • sslmode=disable → disables SSL for local development

3. Install GitHub CLI (gh)

The setup process requires the GitHub CLI for downloading secrets.

Install it from:

https://cli.github.com/

Verify installation:

gh --version

You may also need to authenticate:

gh auth login

4. Download Environment Secrets

Run:

make download-secrets

This command downloads the required secrets and generates the .env file.

5. Update the Database URL in .env

Open the generated .env file.

Find the DATABASE_URL entry and replace it with your local PostgreSQL connection string.

Example:

DATABASE_URL=postgres://postgres:password@localhost:5432/livereview?sslmode=disable

Make sure this points to the database you created in Step 2.

6. Install River

Run:

make river-install

This installs the required River dependencies.

7. Run River Migrations

Run:

make river-migrate

This sets up River-related database tables.

8. Install dbmate

Install it from:

https://github.com/amacneil/dbmate

Verify installation:

dbmate --version

9. Run Database Migrations

Apply all database migrations:

dbmate up

This will create the required database schema.

10. Build the Application

make build-with-ui

11. Install typed Tool

https://github.com/d1vbyz3r0/typed

go install github.com/d1vbyz3r0/typed/cmd/typed@latest
go get github.com/d1vbyz3r0/typed@latest

11. Run the Backend

From the project root directory:

make run

This starts the LiveReview backend server.

12. Run the UI

Open a new terminal:

cd ui
make run

This starts the frontend UI locally.

13. Setup Niceurl

Run either of these:

make niceurl
make niceurl2
make niceurl3

This exposes your local environment through:

  • manual-talent.apps.hexmos.com
  • manual-talent2.apps.hexmos.com
  • manual-talent3.apps.hexmos.com