How connorrmcneil/software-engineering-2025-project works
Project type and purpose
• This is a full-stack, monorepo web application for a language-learning game and dictionary.
• The packages/front-end folder contains a React + Vite + TypeScript SPA with matching-game and dictionary pages.
• The packages/api folder holds a Node/Bun + TypeScript backend using Prisma ORM and SQLite (app.db) to serve REST endpoints for authentication, user data, and word data.
File structure
• Top level:
• Configuration (.gitignore, package.json, tailwind.config.js, etc.)
• packages/api: backend service
• packages/front-end: frontend application
• packages/api/src: organized by controllers (auth.ts, users.ts, words.ts), middleware, and entrypoint (main.ts).
• packages/api/prisma: schema, database file, and seed script.
• packages/front-end/src:
• pages: React page components (matching-game.tsx, dictionary.tsx, etc.)
• components: reusable UI pieces (audio buttons, modals, cards)
• router: loader functions and route configuration
• assets: static audio and image files for the game
• api.ts: frontend HTTP wrapper for calling the backend
README for additional insights
• The README covers naming conventions, not architecture – it confirms use of TypeScript, React, and file naming patterns.