Skip to content

Andowna9/Recipe-Master

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍲 Recipe Master

Contributors Maven Workflow Status Contributors

About The Project

Recipe Master is a social networking platform for sharing and discovering recipes worldwide. Developed by León Abascal, Jon Andoni Castillo, Hazal Demirci, Bidatz Beroiz, and Iñigo de Dios as part of the Software Process and Quality course, the project applies Agile practices using the Scrum framework.

The team has been structured into roles:

  • The Scrum Master manages tasks and workflow via YouTrack.
  • The Product Owner ensures the delivery of valuable features.
  • Developers implement functionalities and track progress.

Recipe Master combines practical software development with a passion for food, creating a space for global culinary connection.

Developed With

Java Maven JavaFX Grizzly MongoDB DataNucleus

Language Support

The application is available in the following languages:

  • 🇬🇧 English
  • 🇪🇸 Spanish
  • 🇹🇷 Turkish
  • 🏴 Basque

The language is automatically loaded based on the system's locale. If the locale does not match any language, it defaults to English.

Features

  • 🆕 Register user accounts.

Register

  • 🔐 Login with existing accounts and remember email if needed.

Login

  • 🔍 Search for recipes/users for some social interaction.

Search

  • ✍️ View and create recipes written using markdown.

View Recipe

  • 📚 Manage your own list of recipe posts and favourites.

Personal List

  • 🧑‍🍳 Create a rich user profile.

Profile

  • 🏠 Access home to check most popular recipes and recent additions.

Home

Getting Started

This guide will help you set up and run the project.

Prerequisites

Before you begin, ensure you have the following installed:

  • Java 11
  • Apache Maven
  • Docker (MongoDB)

Running Locally (Dev)

Run a MongoDB database instance in a Docker container:

docker run --name recipe-master-mongo -p 27017:27017 -d mongo:4.4

Run the following command from the root folder:

mvn clean && mvn clean install

Go to the back-end folder and run the commands below. Keep the back-end running in the background:

cd back-end
mvn compile && mvn exec:java

Open a new terminal, go to the front-end folder, and run:

cd front-end
mvn javafx:run

Docs

Check the Doxygen generated documentation.

Contributors

contrib.rocks image

License

Distributed under the Apache License. See License.

About

Fork from Recipe Master app project.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%