@dlvsoftwaredevelopment/tickety
v1.0.0
Published
Importable Tickety library with API server helpers for organisations (~12k tickets/day)
Downloads
57
Readme
// WARNING: By viewing or using this code, you agree to the terms of Tickety_NDA.txt.
Tickety
Tickety is now an importable npm library built on Express and SQLite. The GUI/Vite client has been removed so the package can be consumed directly from JavaScript and used to start the API server when needed.
Install
npm install @dlvsoftwaredevelopment/ticketyRun
npm run db:init
npm run db:seed
npm run devDefault API base URL:
http://localhost:3001/apiUseful scripts:
npm run dev
npm run dev:resetgen
npm run start
npm run db:sync-reportingLibrary usage
You can import Tickety directly in another Node app:
import tickety from '@dlvsoftwaredevelopment/tickety';
const app = tickety.createApp();
await tickety.startServer({ app, port: 3001 });Named exports are also available:
import { createApp, startServer, createEmergencyBackup } from '@dlvsoftwaredevelopment/tickety';Included API routes
POST /api/auth/loginPOST /api/auth/logoutGET /api/auth/mePATCH /api/auth/mePOST /api/auth/forgot-passwordPOST /api/auth/reset-passwordGET /api/ticketsGET /api/tickets/:idPOST /api/ticketsPATCH /api/tickets/:idPOST /api/tickets/:id/eventsGET /api/queuesGET /api/usersGET /api/users/:idPATCH /api/users/:idGET /api/statsGET /api/logsGET /api/client-portal
Emergency backup
Run:
npm run dev:resetgenThis creates a database backup in server/db/backups and prints a one-time recovery token to the terminal.
