Skip to content

jeremytboyer/rype-project

Repository files navigation

Rype App

Welcome to the Rype App! This web application is designed to bring you a delightful experience in discovering new and exciting food recipes. By harnessing the power of Handlebars, Tailwind CSS, Node, Sequelize, and Express.js we have created an intuitive and visually appealing platform that allows you to explore a wide range of recipes based on the ingredients you have on hand.

Table of contents

Introduction

The primary objective of the Rype App is to simplify the process of finding and trying out new recipes. With our user-friendly interface and powerful search functionality, you can quickly filter through a vast collection of recipes and discover the perfect dish for any occasion. Whether you're a seasoned chef looking to try something new or a cooking enthusiast exploring your culinary skills, the Rype App is here to inspire and delight your taste buds.

Features

  • Intuitive User Interface: Our thoughtfully designed user interface ensures a seamless and enjoyable browsing experience, making it easy for you to find the recipes you love.
  • Ingredient-Based Search: Have some ingredients at home and don't know what to cook? Simply enter them into our search bar, and the Rype App will suggest delectable recipes that match your available ingredients.
  • Comprehensive Recipe Collection: From appetizers and main courses to desserts and beverages, our vast recipe collection covers a wide array of cuisines and cooking styles.
  • You have the opportunity to store your own culinary recipes.

Dependecies

Rype App relies on the following dependencies:

  • mysql2 - Generate RFC-compliant mysql2 in JavaScript.
  • Sequelize - Object-Relational Mapping (ORM) library for Node.js. It supports multiple SQL database systems
  • Express - for routing, middleware, template engines, and more.
  • Dotenv - It helps in managing sensitive data and configuration settings by keeping them separate from the source code
  • Tailwind - CSS framework that provides a set of pre-built utility classes
  • bcrypt- library for hashing passwords in Node.js applications. It provides a secure and efficient way to hash passwords
  • handlebars - It enables developers to create dynamic HTML templates by incorporating logic and data placeholders.

Setup and Installation

  • Clone the repository to your local machine by running the following command: git clone https://github.com/jeremytboyer/rype-project
  • Install all the required dependencies by running npm installas suggested earlier.
  • Set up the database: Make sure you have a MySQL server running. Create a new database and update the connection details in the db/connection.js file.
  • to run the program, use the followin command : node server.js

Usage

  • Click here to visit Rype
  • After opening the application in your web browser, you will see a navigation bar at the top with options for Home, Dashboard, Login, and Register.
  • If you are already logged in, you will see a "Welcome, username" message in the navigation bar along with options for Log Out and your profile dropdown.
  • You can click on "Dashboard" to view your Rype feed, where you can see Rype from other users.
  • To post a new Rype, click on the "Home" link to go back to the home page and enter your engrediente in the Rype box provided.
  • You can have an option to add to Favorites list so next time you need it, your list eill be readily available.

license

GitHub license

This project is licensed under the Apache 2.0 license.

Contributing

Contributions to this project are welcome. If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request or contact us.

Contact and Credit

For any inquiries, please contact me at

Pictures

Screenshot Screenshot

About

A small group project utilizing the Spoonacular API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published