Holy Shiitake

This project was made in a group of 4 over 6 days during week 10 of the 16 week CodeClan Software Developer Bootcamp.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact
4. Acknowledgments

About The Project

Nowadays everyone is trying to build or break a habit. But it's tricky to keep track of them. Identify a habit you'd like to help someone break or build (e.g. alcohol consumption, smoking, calories, exercise, healthy eating...) and make an app to help.

• Make CRUD entries on the front-end that are persisted on a MongoDB database on the back-end
• Display the data in visually interesting / insightful ways.

Habit to track: Home-cooked-meal frequency and mindfulness.

The App can:

• Allow a user to search for recipes based on a key word, e.g. ingredient
• Fetches a random recipe from the API and re-fetches based on a button press
• Presents each recipe with ingredients, an external link and an 'add to entry' button
• Create a diary entry including the recipe name, a date and notes from the user
• Displays the dates a user has entered a diary entry on
• Counts the overall number of entries and shows the user a 'level' of cooking they've achieved

Responsibilities

David

• CRUD actions on the app - add, delete, edit.
• Navbar/hamburger menu
• Mindfulness tip and reward system.

Helen

• Understand and connect to the API
• Render out the results from the API using a flip card visual

Mhairi

• Add an interactive calendar
• Connect the calendar to the entries data
• Style the calendar to reflect dates of entries
• Add a counter for total number of meals made

Stephen

• Add entry form, plus style
• Update entry form, plus style
• CRUD actions - add, delete, update

(back to top)

Built With

• HTML
• CSS
• Javascript
• React
• Express
• Node.js
• MongoDB

(back to top)

Getting Started

Prerequisites

To run this app, please run:

npm ci

in both client and server (see below)

Installation

1. Clone the repo

git clone [email protected]:HelenLangers/Holy_Shiitake_habit_tracker_project.git

2. Create a free account on https://developer.edamam.com/edamam-recipe-api
3. Within the client/src folder create a config.js file:

const config = {
    app_id: ' ',
    app_key: ' '
}

export default config

4. Install the necessary dependencies

cd client
npm ci
..
cd server
npm ci

5. Run the seeds file in the server folder

npm run seeds

6. Start the server

npm run server:dev

7. Start the client

..
cd client
npm start

8. This will automatically open the app in Chrome.

(back to top)

Contact

Helen Langridge - Twitter - LinkedIn

Project Link: Github

(back to top)

Acknowledgments

• CodeClan
• FontAwesome
• EdamamAPI

(back to top)