Welcome to Meal Match

Top-Level Documentation Guide

Here you will find a navigation guide to find the documentation that you are looking for.

UserDocumentation.md Entails:

• High level information about the project
• Information about how users can install and run the software locally on their machines
• An outline of the main functionalities that the Meal Match project supports
• A bug section describing currently known bugs and how to submit bug reports

UserDocumentation.md

DeveloperDocumentation.md Entails:

• Information about how to acquire the source code of meal match
• The directory structure of the code folder
• Information about what coding guidelines the project code utilizes
• The necessary technology required for running Meal Match locally
• How to run tests on the project's code
• How to add custom tests for the project's code
• How to build a release of the project's code

DeveloperDocumentation.md

INSTALL.md Entails:

• The URL of a live version of the project
• Installation steps for getting the project installed on your local machine.

INSTALL.md

SETUP.md Entails:

• Setup steps for getting the project to be able to run locally on your machine.

SETUP.md

team-resources.md Entails:

• Team members and roles
• Project artifacts
• Team member communication policies

team-resources.md

Directory Guide

Here you will find a guide to understanding the contents of the directories of the project

.github Entails:

a workflows directory, which contains a .yaml script file that makes GitHub Actions run and automatically test the code/client and code/server directories' unit tests. This file makes GitHub Actions run whenever a push to any branch occurs, or whenever a pull request to main occurs.

.github

code Entails:

all of the code for the Meal Match application. This code is split up into the client directory code (which houses all the code required to run the client), and the server directory code (which hourses all the code required to run the server).

code

documents Entails:

All of the project related artifacts. One artifact is the 'Front-end Design.pdf' file, which contains the work for the frontend design done by Benjamin Kono and Aiden McCoy. Another is the Poster-Slide.pdf, which contains the poster developed for the Meal Match presentation at OSU in Week 10 of Winter term, 2025.

documents

reports Entails:

All of the project weekly status reports outlining contributions, project goals, and qualititative data about each week of development.

reports