Skip to content

rbrock44/family-recipes

Repository files navigation

Family Recipes

This project holds all the family recipes (and more)
Live - Family Recipes Website

Main


📚 Table of Contents


🧠 What's My Purpose?

This wesbite was created for my grandma (and family) to hold our family recipes. The benefit the website provides over a cookbook is quicker search access and the ability to easily change the number of batches.



To add a recipe use Add Recipe


🚦 How to Use

Seach

Search

A search fires off for every typed character. Every word seperated by a space in the search bar has to be found in either the title, author or number.


Advanced Search

Advanced Search

Advanced search allows the option to only show the Hooper family or select a specific category


Results

Results

The results are shown below in a table. The table can be sorted by any column. Click on a recipe to see more details


Recipe Page

Recipe page

The recipe page shows the title, author, ingredients and instructions for the recipe. The batch control allows the ability to alter the number of batches. The heart favorites the recipe. The top left navigation bar can be used to quickly go forward or backward through results.


Favorites

Favorites

The favorites table contain all recipes that have been hearted. Can be sorted by any column


🛠 Technologies

  • Framework: Angular 13
  • Testing: Karma
  • Deployment: GitHub Pages

🚀 Getting Started (Local Setup)

  • Install node - v19 is needed (v22 also works)
  • Clone repo

Run Locally

npm install
npm start

Test

  • Unit
    • ng test || npm run test
  • Integration
    • ng e2e || npm run e2e

Github Hooks

  • Build
    • Trigger: On Push to Main
    • Action(s): Builds application then kicks off gh page action to deploy build output

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.


Deploy

Run npm run prod to build and deploy the project. Make sure to be on master and that it is up to date before running the command. It's really meant to be a CI/CD action


About

holds all the family recipes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published