Skip to content
GabrielaBerimbau edited this page Sep 13, 2026 · 37 revisions

Mealchemy

An intelligent recipe management and discovery ecosystem - eliminating meal-time indecision by transforming your pantry into personalized, shoppable culinary experiences.


Wiki Navigation

Documentation

Demo 4 - Click to expand

Software Requirements Specifications (SRS)

Page Description
Introduction Project background, motivation, and scope
User Stories Intended users and how they interact with the system
Use Cases High-level use case diagrams and descriptions
Functional Requirements Feature breakdown by subsystem
Non-Functional Requirements Feature breakdown by subsystem
Domain Model UML class diagram

Software Architecture Specifications (SAS)

Page Description
Introduction Project background, motivation, and scope
Architectural Requirements Intended users and how they interact with the system
Technology Requirements Technology Requirements
API Service Contracts API Contracts - OpenAPI Swagger Schema
Deployment Deployment

Other Documents

Page Description
Coding Standards Document Code style conventions and repository structure guidelines
User Manual How to use the app - screenshots and feature walkthroughs
Testing Policy Document Testing standards, types, tools, and responsibilities
Changelog Version history and what changed each demo
Demo 3 - Click to expand

Software Requirements Specifications (SRS)

Page Description
Introduction Project background, motivation, and scope
User Stories Intended users and how they interact with the system
Use Cases High-level use case diagrams and descriptions
Functional Requirements Feature breakdown by subsystem
Non-Functional Requirements Feature breakdown by subsystem
Domain Model UML class diagram

Software Architecture Specifications (SAS)

Page Description
Introduction Project background, motivation, and scope
Architectural Requirements Intended users and how they interact with the system
Technology Requirements Technology Requirements
API Service Contracts API Contracts - OpenAPI Swagger Schema
Deployment Deployment

Other Documents

Page Description
Coding Standards Document Code style conventions and repository structure guidelines
User Manual How to use the app - screenshots and feature walkthroughs
Testing Policy Document Testing standards, types, tools, and responsibilities
Changelog Version history and what changed each demo
Demo 2 - Click to expand

Software Requirements Specifications (SRS)

Page Description
Introduction Project background, motivation, and scope
User Stories Intended users and how they interact with the system
Use Cases High-level use case diagrams and descriptions
Functional Requirements Feature breakdown by subsystem
Non-Functional Requirements Feature breakdown by subsystem
Domain Model UML class diagram

Software Architecture Specifications (SAS)

Page Description
Introduction Project background, motivation, and scope
Architectural Requirements Intended users and how they interact with the system
Technology Requirements Technology Requirements
API Service Contracts API Contracts
Deployment Deployment

Other Documents

Page Description
Coding Standards Document Code style conventions and repository structure guidelines
User Manual How to use the app - screenshots and feature walkthroughs
Testing Policy Document Testing standards, types, tools, and responsibilities
Changelog Version history and what changed each demo
Demo 1 - Click to expand
Page Description
Introduction Project background, motivation, and scope
User Stories Intended users and how they interact with the system
Use Cases High-level use case diagrams and descriptions
Functional Requirements Feature breakdown by subsystem
API Service Contracts API Contracts
Domain Model UML class diagram
Quality Requirements Performance, security, scalability targets
Architectural Patterns Design and architectural pattern decisions
Design Patterns Design and architectural pattern decisions
Architectural Constraints Architectural Constraints
Architectural Diagram System architecture and component overview
Technology Requirements Technology Requirements

Setup Guides

Page Description
Docker Setup Running the full stack locally with Docker Compose
CI Setup GitHub Actions pipeline overview and job breakdown
ACT Setup Running the CI pipeline locally with act
pgAdmin Setup Connecting to the local database via pgAdmin
Security Setup Repo security measurements implace
Render Setup Deployment configuration on Render
Design Spec Deployment Design Deployment setup to GitHub Pages
Wiki Submodule Managing the wiki as a git submodule

Quick Links


Last updated: 27 July 2026 - Team PULSE

Mealchemy

Team PUL5E · COS 301


Documentation

Demo 4
Demo 3
Demo 2
Demo 1

Setup Guides


Quick Links


Updated: 13 September 2026

Clone this wiki locally