Skip to content

postmodernistx/recipe-manager

Repository files navigation

๐Ÿฅ Recipe Manager

Very basic recipe manager, built with Vue 3, Vite and Tailwind (and Vue Router Vuex).

Demo

I wanted to keep the project as light-weight as possible, yet flexible enough to be extended if need be. I also wanted to keep it "database free", so deployment would be a straight-forward procedure.

Recipes are stored as JSON files in src/data/recipes.

โš ๏ธ The project's .gitignore currently ignores all recipe files that do not contain the name .example in the file name.

There's a dark & light theme implemented.

Screenshot of recipe manager with dark theme

Screenshot of recipe manager with light theme

Feature list

  • Clicking on ingredients/steps marks them as done (improve tracking of mise en place/cooking steps)
  • Recipes stored in JSON format (no external database)
  • Basic internationalization
  • Basic recipe metadata (rating, category, cooking time, yield, nutrition)
  • Add print stylesheets
  • Route transitions
  • Scale recipe ingredients

To Do

Deployment

Build the project through the build script in package.json. The current settings are set to up to run the project from a root directory (like a subdomain), but this can be configured through vite.config.js and by setting the base path.

Translations/i18n

This is also kept really low-level in this project. Language JSON files are stored in the folder src/locales.

To create a new language, copy the contents of an existing language file and replace the strings to your liking.

The JSON file is imported in main.js as so:

// ๐ŸŒ Change language here
import locale from './locales/en.json';

The language is then registered and made globally available through app.config.globalProperties.locale = locale; in main.js.

Currently there's ๐Ÿ‡บ๐Ÿ‡ธ English, ๐Ÿ‡ธ๐Ÿ‡ช Swedish and ๐Ÿ‡ซ๐Ÿ‡ฎ Finnish present.

  • The <title> tag needs to be changed manually in index.html, or from the .env file (Vite is adding citation marks)
  • The <html lang=""> attribute needs to be changed manually in index.html

Tech notes

Stack

This project runs on Vue 3 Vite Tailwind Vue Router Vuex (and Prettier for linting).

Upgrading Vue

To upgrade project dependencies, run vue upgrade.