jonaheinke / recipe_manager

Development of a personalized local recipe book. "A personal recipe book without trackers, bloat and ads."

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Personal website for managing recipes

license last commit open issues code size

Description

TODO

Goals

  • creating a simple, local recipe book 📙 directed at domestic use
  • simple import from other recipe websites ⤵
  • light on data traffic (when using mobile data)
  • no annoying trackers, ads and life-changing background stories ❌🗨
  • simple HTML, CSS and JS without unnecessary code or wrapper elements 🧾
  • can be hosted locally or on a cheap/free server 🖥

Navigating the repo

Recommendation: install the Sass and Sass Live Compiler extensions for VS Code

  • index.html is the main page, you should study this first
  • if you want to study the recipe database, look into TODO
  • if you want to study the search index, look into TODO

Installation

Requirements for local PC

Requirements for webserver

  • PHP 7.1 or newer
  • MySQL
  • PDO extension for PHP
  • SQLite Extension for PHP
  • mbstring xtension for PHP
  • .htaccess enabled with rewrite engine

Setup

  1. git clone to local folder
  2. (not recommended) for newest TNTSearch version: run composer update in the project root and skip to step 4
  3. run composer install in the project root
  4. copy local folder contents to the root of the webserver
  5. create a MySQL database and user
  6. (optional) import the last backup to the database
  7. save the database credentials to a file TODO
  8. done!

About

Development of a personalized local recipe book. "A personal recipe book without trackers, bloat and ads."

License:MIT License


Languages

Language:HTML 42.3%Language:SCSS 33.7%Language:JavaScript 19.0%Language:PHP 4.9%