Skip to content

vheeno/Whisker

Repository files navigation

Whisker 🍽️

Whisker Logo

Whisker is an iOS app designed to help you scale, convert, and organize your favorite recipes. Whether you're cooking for one or a crowd, Whisker makes it easy to adjust ingredient quantities and keep your recipes in order.

Table of Contents

Features

  • Recipe Scaling: Easily adjust the quantities of ingredients based on the number of servings you need.
  • Unit Conversion: Convert between different measurement units with a simple tap.
  • Organize Recipes: Keep your recipes organized with tags and categories.
  • Search Functionality: Quickly find your recipes with a powerful search tool.
  • User-Friendly Interface: Enjoy a clean and intuitive design that makes cooking a breeze.

Technologies Used

Whisker is built using the following technologies:

  • Swift: The main programming language for iOS development.
  • SwiftUI: For building user interfaces in a declarative way.
  • Alamofire: For handling network requests.
  • MVC: Model-View-Controller architecture for a clean separation of concerns.
  • Swiftsoup: For parsing HTML data.
  • Facebook SDK: For social sharing features.
  • Google APIs: For enhanced functionality.

Installation

To install Whisker, follow these steps:

  1. Clone the repository:
    git clone https://github.com/vheeno/Whisker.git
  2. Navigate to the project directory:
    cd Whisker
  3. Open the project in Xcode:
    open Whisker.xcodeproj
  4. Build and run the app on your iOS device or simulator.

Usage

Once you have installed Whisker, you can start using it right away. Here’s how:

  1. Adding a Recipe: Tap on the "Add Recipe" button and fill in the details.
  2. Scaling Ingredients: Select the number of servings you want, and the app will automatically adjust the ingredient quantities.
  3. Converting Units: Use the conversion tool to switch between different measurement units.
  4. Organizing Recipes: Tag your recipes for easy searching and organization.

Contributing

We welcome contributions to Whisker! If you have ideas for improvements or new features, please follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/YourFeatureName
  3. Make your changes and commit them:
    git commit -m "Add your message here"
  4. Push to your branch:
    git push origin feature/YourFeatureName
  5. Create a pull request.

License

Whisker is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any inquiries or feedback, please reach out to the maintainer:

Releases

You can find the latest releases of Whisker here. Please download and execute the necessary files to get the latest version.

Feel free to explore the "Releases" section for updates and new features.

Acknowledgments

We would like to thank the following resources for their support:


Badges

Swift iOS License


Feel free to customize this README file further to match your specific needs and preferences.