Welcome to Village Food Hub!

PR Description Template (Please don't edit this! Copy-paste the template into the PR Description)

Title: Brief description

Names:

Date:

How long did this ticket take you?

Description:

Testing (before and after screenshots): Takeaways:

Git Do's and Don'ts

*DON'T

• UNDER NO CIRCUMSTANCES mess with the branch named "main" => your default should be the dev branch
• don't push to dev directly, you should be working on a different branch as dev will be the branch we push our most up to date code to
• don't handle merge conflicts without Jiyoon being present
• don't be afraid if you have made a git mistake!! ultimately, the whole purpose of git is to save our work consistently to prevent disasters, so more likely than not, any git mistakes can be fixed! reach out to Jiyoon if this does happen and she will help!

*Do

• Git cheat sheet: https://education.github.com/git-cheat-sheet-education.pdf
• make git commits locally often! saving your work consistently with git will tremendously help if there are any issues/conflicts with code down the road.
• For creating a NEW branch,

  git checkout dev
  git pull
  git checkout -b [your_branch_name]
  npm install
  

• If you have just begun a coding session after a few days, run the following git commands:

  git checkout dev
  git pull  
  git checkout [curr_branch]
  git merge dev
  npm install
  

• If you see on github that the current branch you're on is behind the dev branch: (if you have unsaved changes, first commit your changes or stash them)

  git checkout dev
  git pull
  git checkout [curr_branch]
  git merge dev
  npm install
  

  This will merge everything from the dev branch onto your current branch.
• If you have just finished editing a few files, and would only like to set a SINGLE file to the stage:

  git add [filename]
  

• If you would like to add all of the files you edited to the stage:

  git add .
  

• If you have added files to the stage and would like to commit them to the stage:

  git commit -m "[insert message here]"
  

• If you have made commits to your local branch and would like to push to github:

  git push
  

IMPORTANT: Code Conventions

• We will not be accepting code without any comments!!
  • Functions should have a description of what it does
  • large loops or code with a lot of logic should have a description as well
• Use camelCase instead of underscores for variable names or filenames
• Since you will be working on a separate branch from our dev branch, you will need to submit pull requests (PRs) along with your testing process.
• Since you will be working on a separate branch from our dev branch, we will also be using a naming convention for the branches:

  [frontend or backend]/[ticket#]-ticket-title
  

  • For example, say I am a frontend developer working on ticket #45 whose title is "creating profile page", my branch will be named frontend/45-creating-profile-page

Using Flowbite?

To convert HTML to TypeScript (specifically JSX/TSX for React), you need to follow these steps:

1. Change class to className:
   1. In JSX/TSX, the class attribute is replaced with className.
2. Use htmlFor Instead of for:
   1. In JSX/TSX, the for attribute in <label> tags is replaced with htmlFor.
3. Self-Closing Tags:
   1. Ensure that self-closing tags like <input /> are properly formatted.
4. Ensure Proper Syntax:
   1. Make sure the JSX/TSX syntax is correct, including proper nesting and closing of tags.

Web App Info

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

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

Open http://localhost:3000 with your browser to see the result.

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

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.