Food For Free

This GitHub repository contains the code behind Food For Free's recipient partner portal.

Project Manager (PM): Riddhi Sahni
Technical Lead (TL): Benjamin Li

---

1. Install Prerequisites

Make sure you have the following installed:

• Node.js (LTS recommended) → Download here
  Verify installation:

  node -v
  npm -v

• Git → Download here
  Verify installation:

  git --version

---

2. Clone the Repository

git clone https://github.com/JumboCode/food-for-free.git
cd food-for-free

---

3. Install Dependencies

Inside the project folder:

npm install

---

4. Stay Up To Date

Before starting development for each sprint, make sure you are working from the most recent version of main.

1. Start on main and update it:

git checkout main
git pull origin main

2. Create your code branch from the fresh main:

git checkout -b sprintnumber/feature-name

3. Work on your feature.

Commit and push as usual.

4. If main changes while you’re working (because someone else merged first), update your branch:

git pull origin main

(run this while staying on your branch)

---

5. Start the Development Server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Then open http://localhost:3000 in your browser.

You can edit the app by modifying app/page.tsx. The page auto-updates as you edit the file.

---

6. Workflow Notes

• Always git pull before making changes.

• Create a new branch for your work:

  git checkout -b <branch-name>

• Commit and push your branch, then open a Pull Request (PR) for review.

Branch Naming Convention

Branches should follow this format:

<sprintnumber>/<feature-name>

• Sprint number: Always 2 digits (starting at 00 for the first week's sprint, then incrementing).
• Feature name: Short, descriptive, and use dashes between words.

Examples

git checkout -b "00/add-weather-button"
git checkout -b "01/create-login-page"
git checkout -b "02/setup-database-schema"

Note: Specifying -b causes a new branch to be created. You only need to run this when first creating the branch; when checking out to an existing branch the -b flag does not need to be included.

---

Learn More

• Node.js Docs
• Git Docs
• Next.js Docs
• Interactive Next.js Tutorial

---

Deploy on Vercel

We use Vercel for deployment. See Next.js deployment documentation for details.