Skip to content
 
 

Repository files navigation

Easy Read Document Generator

A UI prototype for the Easy Read Document Generator: responsive interface, mock backend (SQLite), and document editing flows.

Getting Started

  1. Install dependencies (installs root + mock-server):

    npm install
  2. Environment (optional — defaults work locally):

    cp .env.example .env.local
  3. Run development (Next.js + mock API on port 5050):

    npm run dev
  4. Open http://localhost:3000

Demo login

Email Password
jane.doe@uwa.edu.au password123
john.smith@uwa.edu.au password123
alex.lee@uwa.edu.au password123

See DEMO.md for a full walkthrough.

Architecture

  • Next.js (src/app/) — UI and API routes that proxy to the mock server
  • Mock server (mock-server/) — Express + SQLite (mock-server/data/mock.db, gitignored)
  • Auth uses session cookies from the mock server (/api/auth/login, /api/users/me, etc.)

Scripts

Command Description
npm run dev Next.js + mock server
npm run dev:next Next.js only
npm run dev:mock Mock server only
npm run build Production build
npm run lint ESLint

Folder structure

  • src/app/ — pages and API routes
  • src/components/ — UI components
  • src/lib/ — API clients, hooks, config
  • mock-server/ — local backend
  • figma/ — design references

Limitations (demo)

  • Publish/export is UI-only
  • Settings billing and some save buttons are not wired
  • Image library is built from document section images, not a full media service

License

Private demonstration project. Placeholder images are for demo only.

About

UI design prototype for Easy Read Document Generator

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages