https://github.com/millroy094/recipe-book

https://github.com/millroy094/recipe-book

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/millroy094/recipe-book
• Owner: Millroy094
• Created: 2024-06-20T09:43:33.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-04T14:42:17.000Z (6 months ago)
• Last Synced: 2024-07-04T21:25:21.279Z (6 months ago)
• Language: TypeScript
• Size: 2.54 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Recipe APP

## Introduction

Recipe app is an end to end application allowing an user to add their favourite recipes to their collection. The information stored on this app includes the name of the recipe, ingredients, and the steps.

## Architecture

The application consists of two parts the front-end and back-end. 

The frontend consisting of two pages:

1. Listing page: this is where all the recipes along with their ingredients are displayed. The user can then filter this list via recipe name search or ingredient filter.

2. More info page: this where the user can see more details of their recipe and even update these details.

The backend uses:

1. Dynamo DB to store data.

2. GraphQL Express API to allow CRUD behaviour.

## Infrastructure

The frontend is hosted on an s3 bucket behind AWS CloudFront and the GraphQL backend sits inside a lambda function that communicates with Dynamo DB for storage.

## CI/CD

Update any merge into the main branch a GitHub Action is triggerd that runs:

1. Unit tests on frontend and backend.

2. Builds and deploys website to S3/CloudFront and GraphQL Express Server to AWS Lambda.

3. E2E tests to validate the build and deploy.