Sharp Cooking Web

Sharp Cooking is a recipe book app originally created for iOS and Android using Xamarin platform. The original app repository is now public and available at sharp-cooking. However, the iOS and Android apps are no longer maintained and will be pulled from the app store in the near future.

This version of Sharp Cooking aims to provides the same features as the original app but as a installable web app (PWA) instead of native. In addition to the web app, a Python API is also provided for internal consumption only for recipe scraping.

Contributions

Feel free to contribute with issues and pull requests. However, please keep it cordial and understand this is a work of love and not money.

Helpful reads

• PWA
• Vue 3
• Vite
• Typescript
• Python
• Azure Static Web Apps
• Azure Static Web App API
• Azure Functions with Python
• Sharp Cooking blog posts

Running the web app

1. If you intend to contribute back to this repository, please fork it before following the next steps.
2. Ensure you have npm and yarn installed. If you already have npm, you can install yarn with npm:

npm install --global yarn

2. CD into the project root directory

cd c:\code\sharp-cooking-web

3. Install package dependencies

yarn

4. Run

yarn dev

Running the API with VS Code

1. Install the recommended extensions from .vscode/extensions.json
2. Ensure you have installed Python 3.10 or later. You should install the version from Python's web site and not from the windows store or other alternate sources.
3. See Microsoft Quickstart for how to run the function locally.

Unit tests

Sharp Cooking leverages Playwright for end to end tests. All major functionality is currently tested and contributors are expected to include reasonable tests for any code changes.

Install playwright browsers:

npx playwright install chromium firefox webkit

Run tests locally:

yarn dev
npx playwright test