Skip to content

M-Facey/formjam

Repository files navigation

FormJAM: Another form app

App Banner

This is a simple app created using Vue 3 and Pocketbase. The src documentation found here can help newcomers understand how the project is broken down based on folder structure. ⚠️ The docs for different folders are still being worked on.

💻 The Tech I Used

Front end

Back end

🛠️ How To Run

First, copy the values from .env.example into a .env file and set the value according what your specific setup (Please see values below). Afterwards, navigate the root folder and run any of the following commands.

VITE_POCKET_BASE="http://127.0.0.1:8090" # default port for pocketbase
BASE_URL="http://localhost:5173" # default port for app

API_URL="http://127.0.0.1:8090" # same as the local or production pocketbase instance
USER_EMAIL="[email protected]"
USER_PASSWORD="password"

Install the dependencies

pnpm install

Run dev mode

pnpm dev

Type-check and run build for production

pnpm build

Run production preview

pnpm preview

Run E2E tests with headless browser/electron

pnpm test:e2e

Run E2E tests with Cypress UI

pnpm cypress:open

How to contribute

Please check out CONTRIBUTING.md