core - GitLite

KO | EN

gitlite — search

#javascript #typescript #golang #android #rust #docker #nodejs #awesome #awesome-list #vue #security #mcp #openai #open-source

core

(★ 164)

KitchenPC core engine and database adapter

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - build.yml
  - publish.yml
- CODEOWNERS
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- SECURITY.md
- - Amount.cs
  - AuthIdentity.cs
  - Core.csproj
  - Enums.cs
  - Exceptions.cs
  - Extensions.cs
  - FormConversion.cs
  - Fractions.cs
  - Unit.cs
  - UnitConverter.cs
  - Weight.cs
- - DatabaseAdapter.cs
  - DatabaseAdapterBuilder.cs
  - DatabaseExporter.cs
  - DatabaseImporter.cs
  - DB.csproj
  - EnumMapper.cs
  - NHSearch.cs
- - KPCData.xml
- - Categorization.cs
  - IngredientBinding.cs
  - Modeler.cs
  - ModelerData.xml
  - NLP.cs
  - RecipeSearch.cs
  - Tags.cs
  - TestFormLoader.cs
  - TestIngredientLoader.cs
  - TestPrepLoader.cs
  - TestUnitLoader.cs
  - UnitConverter.cs
  - Units.cs
  - UnitTests.csproj
- .editorconfig
- core.slnx
- dotnet-tools.json
.editorconfig
.gitattributes
.gitignore
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/KitchenPC/core

Downloads the entire project code from GitHub to your computer.

cd core

Moves into the project folder you just downloaded.

2. .NET

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
.NET SDK The SDK required for the dotnet command.

dotnet restore src/core.slnx

Downloads the packages the project depends on.

dotnet build src/core.slnx --configuration Release --no-restore

Type this command into your terminal and run it.

dotnet test src/UnitTests/UnitTests.csproj --configuration Release --no-build --no-restore

Type this command into your terminal and run it.

✅ After dotnet run, check the message or address shown in the terminal.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

What is KitchenPC?
====

KitchenPC is a free, open-source framework written in C# for working with recipes, shopping lists, and menus.  It provides a standardized data model for representing normalized ingredient and recipe information, and allows ingredient usage to be aggregated across recipes automatically.  The core KitchenPC framework includes:

1. Base classes for describing and working with core recipe-related concepts.
2. A **recipe modeling engine** capable of building sets of recipes that efficiently use a set of ingredients and amounts.
3. A **natural language parser** which can convert human input ("a dozen eggs") to a normalized ingredient usage structure (whole eggs: 12)
4. A **categorization engine** which can take recipe objects and catagorize them as breakfast, lunch, dinner or dessert.  This engine can also derive nutrional information based on USDA data, a taste profile (sweet, savory, spicy, mild) based on ingredients and amounts used, dietary flags (vegetarian, gluten-free, low-calorie, etc) and other aspects of the recipe.
5. An extensible framework to define how data is loaded and saved to a persistence mechanism, such as a SQL database or full-text search engine.

How To Get Started
====

Getting started is simple, and data can be loaded locally from an XML file for testing.  Sample data is included with the source, which includes a few dozen recipes, along with sample menus and shopping lists.

The best way to get up and running is to read the blog post titled [Getting Started with KitchenPC](http://blog.kitchenpc.com/2014/02/10/getting-started-with-kitchenpc/) which includes an introduction to core concepts as well as several samples.

1. [Getting Started](http://blog.kitchenpc.com/2014/02/10/getting-started-with-kitchenpc/)
2. [Provisioning a Database](http://blog.kitchenpc.com/2014/02/11/kitchenpc-database-provisioning-101/)
3. [Logging](http://blog.kitchenpc.com/2014/02/13/kitchenpc-logging-101/)
4. [Creating a Recipe](http://blog.kitchenpc.com/2014/02/14/lets-make-a-recipe/)

Building and Testing
====

Install the .NET 10 SDK, then restore, build, and test from the repository root:

```bash
dotnet restore src/core.slnx
dotnet build src/core.slnx --configuration Release --no-restore
dotnet test src/UnitTests/UnitTests.csproj --configuration Release --no-build --no-restore
```

The build includes `KitchenPC.Core`, `KitchenPC.DB`, the unit tests, and the WebApp sample.

Packages and Releases
====

Every push and pull request builds and tests the solution, then creates matching prerelease packages for CI validation. Version tags publish `KitchenPC.Core` and `KitchenPC.DB` to NuGet with the same version. For example:

```bash
git tag -a v1.0.0 -m "KitchenPC 1.0.0"
git push origin v1.0.0
```

NuGet package versions are immutable. Always increment the version for a subsequent release.