https://github.com/federicobonel/ambrobook

Spring MVC Application for sharing recipes through the web
https://github.com/federicobonel/ambrobook

Last synced: 11 days ago
JSON representation

Spring MVC Application for sharing recipes through the web

• Host: GitHub
• URL: https://github.com/federicobonel/ambrobook
• Owner: FedericoBonel
• Created: 2022-02-28T08:56:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-18T04:35:11.000Z (7 months ago)
• Last Synced: 2024-07-18T06:42:45.698Z (7 months ago)
• Language: Java
• Homepage:
• Size: 114 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AmbroBook

[![CircleCI](https://dl.circleci.com/status-badge/img/circleci/MXqELc8ViZYB9hfQ6uBdG5/Piv3t66JdaSYv5QL8qyNbF/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/circleci/MXqELc8ViZYB9hfQ6uBdG5/Piv3t66JdaSYv5QL8qyNbF/tree/main)

## What is this repository?

There are many things I'm passionate about, and two of them are technology and food. Having worked in kitchens a lot in the past, I always enjoy sharing my knowledge with others. So, I decided to build a simple yet robust web application that allows you to share your recipes with anyone!

This is a full-stack website that you can download and run to have your own responsive recipe-sharing site, right out of the box.



## What do I need to do to run it and start sharing my recipes?

Not too much, you just need maven. Once you have that, all you have to do is download this source code, go to its root 

folder and package it. You can do it through this command:

    mvn clean install

Once you've done this you will have a /target folder. You need to open your command line to that folder and then run 

the following command:

    java -jar recipe-mvc-0.0.1-SNAPSHOT.jar

Once you've done that you'll have the application running on your ip on port 8080.

**_NOTE:_**  This will run the application with an in memory relational database, this is not what you want if you 

were to deploy the app.

To "deploy" the app, what you'll need to do is create a mySQL database with the SQL script contained in 

src/main/java/resources/scripts in a database called "recipes_prod".

Then you'll need to create a database user called "recipe_prod_user" and set whichever password you want for it.Then 

you'll 

need to set that 

password in the src/main/java/resources/application-prod.properties file, set the user permissions to only data 

management operations (no DDL allowed) in the database and finally run the app.

## Is it only available in English?

Nope! This app allows localization, currently it has Spanish and English support but if you wish to add any other 

language, feel free to fork the repo and request a pull request! I'll make sure to bring it in to the main branch.

## Tech stack

The app is built primarily using the Spring framework stack combined with some other technologies:

* Spring Data JPA

* Thymeleaf

* Spring Web MVC

* Hibernate

* Spring Security

* In memory H2 database

* Lombok

* JUnit 5

* Bootstrap 5

* MySQL (MongoDB in the second branch with reactive programming using webflux)

* CircleCI

* Much more...