Merge pull request #49 from plutov/vuejs-ui

client-only

Author: plutov

.github/workflows/test.yaml

@@ -7,8 +7,8 @@ on:
     branches:
       - main
 jobs:
-  lint:
-    name: Lint Go
+  lint-test-go:
+    name: Lint and Test Go
     runs-on: ubuntu-latest
     steps:
       - name: Install Go
@@ -24,18 +24,6 @@ jobs:
         with:
           working-directory: ./api
 
-  test:
-    name: Test Go
-    runs-on: ubuntu-latest
-    steps:
-      - name: Install Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: 1.24
-
-      - name: Check out code
-        uses: actions/checkout@v4
-
       - name: Run Tests
         working-directory: ./api
         run: go test -v -bench=. -race ./...
@@ -45,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node_version: [20]
+        node_version: [22]
 
     steps:
       - name: Check out code

README.md

@@ -266,53 +266,43 @@ http://localhost:9900/app/surveys/{SURVEY_ID}/sessions?limit=100&offset=0&sort_b
 
 Where `{SURVEY_ID}` id the UUID of a given survey.
 
-## Screenshots
-
-<p align="center" width="100%">
-	<img src="https://github.com/plutov/formulosity/blob/main/screenshots/app.png" hspace="10" height="200px">
-	<img src="https://github.com/plutov/formulosity/blob/main/screenshots/survey.png" hspace="10" height="200px">
-</p>
-
 ## Installation & Deployment
 
-You can build and run both API and UI with Docker Compose:
+### API and Postgres with Docker Compose
+
+You can build and run both API and Postgres with Docker Compose:
 
 ```
 docker-compose up -d --build
 ```
 
-And you should be able to access the UI on [localhost:3000](http://localhost:3000) (default basic auth: `user:pass`).
-
-You can deploy individual services to any cloud provider or self host them.
-
-- Go backend.
-- Next.js frontend.
-- Postgres database.
-
-### Environment Variables
+Environment variables:
 
 API:
 
 - `DATABASE_URL` - Postgres connection string
 - `SURVEYS_DIR` - Directory with surveys, e.g. `/root/surveys`. It's suggested to use mounted volume for this directory.
 - `UPLOADS_DIR` - Directory for uploading files from the survey forms.
 
-UI:
-
-- `CONSOLE_API_ADDR` - Public address of the Go backend. Need to be accessible from the browser.
-- `CONSOLE_API_ADDR_INTERNAL` - Internal address of the Go backend, e.g. `http://api:8080` (could be the same as `CONSOLE_API_ADDR`).
-- `IRON_SESSION_SECRET` - Secret for session encryption
-- `HTTP_BASIC_AUTH` - Format: `user:pass` for basic auth (optional)
-
 ### Run UI with npm
 
-It's also possible to run UI using `npm`:
-
 ```
+cd ui
 npm install
 npm run dev
 ```
 
+### Run API locally
+
+Assuming you have Postgres running locally (`docker-compose up -d postgres`), you can run the API with:
+
+```
+cd api
+export DATABASE_URL="postgres://user:pass@localhost:5432/formulosity?sslmode=disable"
+export SURVEYS_DIR="./surveys"
+go run main.go
+```
+
 ## Tech Stack
 
 - Backend: Go, Postgres

compose.yaml

@@ -14,19 +14,6 @@ services:
     volumes:
       - ./api/surveys:/root/surveys
       - ./api/uploads:/root/uploads
-  ui:
-    restart: always
-    build:
-      context: ./ui
-    ports:
-      - "3000:3000"
-    environment:
-      - CONSOLE_API_ADDR_INTERNAL=http://api:8080
-      - CONSOLE_API_ADDR=http://localhost:9900
-      - IRON_SESSION_SECRET=e75af92dffba8065f2730472f45f2046941fe35f361739d31992f42d88d6bf6c
-      - HTTP_BASIC_AUTH=user:pass
-    depends_on:
-      - api
   postgres:
     image: postgres:16.0-alpine
     restart: always

screenshots/app.png

@@ -1,5 +1,4 @@
-CONSOLE_API_ADDR=http://localhost:9900
-CONSOLE_API_ADDR_INTERNAL=http://localhost:9900
+NEXT_PUBLIC_API_ADDR=http://localhost:9900
 IRON_SESSION_SECRET=not_very_secret_replace_me
 HTTP_BASIC_AUTH=user:pass