README.md

Creole Food

Online cooking recipe organizer.

Key Features • How To Use • Credits • Authors • License

Key Features

• Add recipes to the the default recipe collection.
  • Required input:
    • Title - The title of the recipe.
    • Serving - The number ofpossible servings.
    • Ingredients - List of all ingredients.
    • Direction - List of steps for completion.
  • Optional input:
    • Image - Url of image location.
    • Note - Additional notes accompanying the recipe.
• Edit existing recipes from the collection.
• Remove existing recipes from the collection.
• Preview edited or created recipes before adding to the collection.
• Download pdf version of a recipe from the collection.

How To Use

1. Run online live version.
2. Clone and run this application. You'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/nhope123/creole_food.git

# Go into the repository
$ cd creole_food

# Install dependencies
$ npm install

# Run the app
$ npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Credits

This software uses the following open source packages:

• React - A JavaScript library for building user interfaces
• Redux - A Predictable State Container for JS Apps
• Redux-toolkit - The official toolset for efficient Redux development
• Node.js - An asynchronous event-driven JavaScript runtime
• Bootstrap - CSS framework for managing UI layout.-
• React Modal - Accessible modal dialog component for React.JS
• pdfMake - PDF document generation library for server-side and client-side.
• icon-icons - Free icons for personal and commercial use

Authors

• Nial Hope - Repository
  • Portfolio
  • Linkedin

License

Creole Food is an open source software licensed as GNU General Public License v3.0.