Skip to content

tgharbert/Ko-Mi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ko-mi logo

Ko-Mi

View Live

About

Ko-Mi is your ultimate grocery shopping assistant and cookbook companion! With Ko-Mi, planning meals, creating shopping lists, and discovering new recipes has never been easier. Seamlessly browse through a vast collection of delicious recipes, organize your ingredients, and streamline your shopping experience, all in one intuitive app.

PetCentral is a full-stack application that allows users to connect with other pet owners in their area.

Some of our key features are:

  • Secure Sign-in

    Sign in with Google OAuth. Rest easy knowing that your safety and privacy are a top priority!

    auth demo

  • Main Page

    Browse all the recipes that you've added. A custom cookbook with only the necessary information for each recipe! You're able to add ingredients to your shopping list and scale them appropriately.

    homepage demo

  • Search Recipes

    Filter and search recipes to find whatever you desire in your cookbook. Search by Keyword, Author, Title, or Ingredients!

    searchbar demo

  • Add a Recipe

    Add to your cookbook by inputting a URL or build a custom recipe card! Our site is able to grab the necessary information from most sites then create a recipe card.

    add recipe demo

  • Shopping List

    View items in your shopping list and check them off as needed. Add custom items to make it your single resource when looking through your supplies at home or browsing the store.

    shopping list demo

What's in a name?

Ko-Mi is a phoenetic spelling of "commis," the French term for a professional kitchen assistant who works under the supervision of a chef.

Built With

Typescript next.js React Prisma Supabase Tailwind CSS

Getting Started

Before getting started with Ko-Mi please ensure that you have a database set up to work with Prisma. We highly recommend Supabase

Prerequisites

NPM

npm install npm@latest -g

Node.js

Node version is expected to be v20.10.0 or higher

nvm install --lts
node --version

Installation

  1. Clone the repo
    git clone https://github.com/SA-BlueOcean/PetCentral.git
  2. Install NPM packages
    npm install
  3. Rename .env.example to .env and fill in the following fields:
     GOOGLE_CLIENT_ID
     GOOGLE_CLIENT_SECRET
     DATABASE_URL
     NEXTAUTH_SECRET
     NEXT_PUBLIC_SUPABASE_URL
     NEXT_PUBLIC_SUPABASE_ANON_KEY
    
    Check NextAuth.js documentation for more information on how to set up OAuth providers
  4. Run Prisma generate to generate the Prisma client
npx prisma generate
  1. Push schema to the database
npm run db:push
  1. Run the development server
npm run dev

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 Inter, a custom Google Font.

Releases

No releases published

Packages

No packages published