Skip to content

KWARC/GloX

Repository files navigation

GloX -- The FAUstairs Glossary Extractors and Curator

See the GloX blue note for the ideas.

Getting Started

GloX — Updated Setup Instructions

  1. Prerequisites • Node.js ≥ 20 • pnpm ≥ 9 • PostgreSQL ≥ 14

  2. Environment Configuration

Create a .env file at the project root with the following variables:

DATABASE_URL=postgresql://USER:PASSWORD@HOST:PORT/DB_NAME
VITE_FTML_SERVER_URL=https://mathhub.info

JWT_SECRET=replace_with_strong_random_secret

NODEMAILER_EMAIL_ID=your_email@example.com
NODEMAILER_EMAIL_PASSWORD=app_specific_password

APP_ORIGIN=http://localhost:3000
NODE_ENV=development
  1. Dependency Installation
pnpm install

This installs: • React 19 + Vite 7 toolchain • TanStack Router / Query / Start stack • Prisma client and PostgreSQL adapter • FTML frontend and backend libraries • Mantine UI + Tailwind v4

  1. Database Setup (Prisma)

Generate client and apply schema:

pnpm prisma generate
pnpm prisma migrate dev
  1. Development Server
pnpm dev
•	App runs at http://localhost:3000
•	Vite dev server with HMR
  1. Production Build
pnpm build
pnpm preview
  1. Testing
pnpm test

About

The FAUstairs Glossary Extractors and Curator

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors