diff --git a/README.md b/README.md index fbd1e0c10d..632aa89103 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,25 @@ -# What's Cookin'? Starter Kit +# What's Cookin' -The details of this project are outlined in the project spec. +### Abstract: +View delicious meals, sauces, desserts and more from over 40 different recipes! Search for specific recipes based on ingredients or name. Filter recipes with the included filters. Click on a recipe for a detailed ingredients and directions pop-up. Save a recipe to the saved recipe section by clicking the button on the bottom of the recipe container. -## Set Up +### Installation Instructions: +No need to install! View here - [GitHub Pages](DEPLOYED URL HERE) -1. Within your group, decide on **one** person to have the project repository on their Github account. This person will *fork* this repository - on the top right corner of the page, click the fork button. -1. Add all group members and your PM as collaborators on the repo -1. All group members should then clone down the forked repository. Since you don't want your project to be named "whats-cookin-starter-kit", add an optional argument after the repo url when cloning. The command should look like this: `git clone [remote-address] [what your group wants to name the repo]`. -1. Once you have cloned the repo, change into the directory and install the project dependencies. Run `npm install` or `npm i` to install project dependencies. -1. Run `npm start` in the terminal to see the HTML page (you should see some boilerplate HTML displayed on the page). - - `Control + C` is the command to stop running the local server. Closing the terminal without stopping the server first could allow the server to continue to run in the background and cause problems. - - This command is not specific to Webpack; make note of it for future use. -1. Do not run `npm audit fix --force`. This will update to the latest version of packages. We need to be using `webpack-dev-server@3.11.2` which is not the latest version. If you start to run into Webpack errors, first check that all group members are using the correct version. +## Preview of App: +![WhatsCookinGif](GIF URL HERE) -## Testing -Mocha and chai are already set up, with a boilerplate test for you. +## Context: +This is our first group project of Mod 2 at Turing School of Software & Design. We were given ~1 week to create this project from scratch using a provided comp found [here](https://frontend.turing.edu/projects/module-2/whats-cookin-part-one.html). + +## Contributors: +[Johann Dee](https://github.com/joh-ann), [Nicole Rue](https://github.com/nicolerue), [Patrick Eitel](https://github.com/pitter3) + +## Learning Goals: +- Use object and array prototype methods to perform data manipulation. +- Create a user interface that is easy to use and clearly displays information. +- Write DRY, reusable code that follows SRP and trends toward function purity. +- Implement a robust testing suite using TDD. +- Make network requests to retrieve data. +- Collaborate productively and professionally as a team. Ensure all team members are able to be heard and contribute throughout the project. \ No newline at end of file diff --git a/dist/bundle.js b/dist/bundle.js index 66bfcbdd3b..29d4e00234 100644 --- a/dist/bundle.js +++ b/dist/bundle.js @@ -2,7 +2,7 @@ /******/ (() => { // webpackBootstrap var __webpack_exports__ = {}; - alert('hello') + // alert('hello') /******/ })() ; \ No newline at end of file diff --git a/dist/index.html b/dist/index.html index 630ecfc1c1..a1fd5623b5 100644 --- a/dist/index.html +++ b/dist/index.html @@ -1,12 +1,92 @@
- -