{"id":25231983,"url":"https://github.com/itsdaiton/food-square-api","last_synced_at":"2026-05-05T23:32:38.158Z","repository":{"id":43083700,"uuid":"463474192","full_name":"itsDaiton/food-square-api","owner":"itsDaiton","description":"Repository for server side of bachelor project at Prague University of Economics and Business.","archived":false,"fork":false,"pushed_at":"2024-07-01T10:16:10.000Z","size":479,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-05T16:20:50.482Z","etag":null,"topics":["bachelor-project","cooking","java","meal-planner","open-source","postgresql","recipes","rest-api","social-network","springboot","springframework"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsDaiton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-25T09:33:12.000Z","updated_at":"2024-07-01T10:15:05.000Z","dependencies_parsed_at":"2025-02-11T12:54:58.424Z","dependency_job_id":"54a19d37-67a0-493d-903b-3c09a663aaf2","html_url":"https://github.com/itsDaiton/food-square-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/itsDaiton/food-square-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsDaiton%2Ffood-square-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsDaiton%2Ffood-square-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsDaiton%2Ffood-square-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsDaiton%2Ffood-square-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsDaiton","download_url":"https://codeload.github.com/itsDaiton/food-square-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsDaiton%2Ffood-square-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32672633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-05T11:29:49.557Z","status":"ssl_error","status_checked_at":"2026-05-05T11:29:48.587Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bachelor-project","cooking","java","meal-planner","open-source","postgresql","recipes","rest-api","social-network","springboot","springframework"],"created_at":"2025-02-11T12:54:53.046Z","updated_at":"2026-05-05T23:32:38.137Z","avatar_url":"https://github.com/itsDaiton.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Food Square\nSocial network for food lovers.\n\nFood Square was developed as an open source application as a part of bachelor thesis titled ***Design and implementation of an open source web application about cooking*** by David Poslušný at [***Faculty of Informatics and Statistics of Prague University of Economics and Business***](https://fis.vse.cz).\n\nℹ️ This bachelor thesis **was defended on 31.1.2023 with the grade of 1**. Link to the paper can be found [**here**](https://vskp.vse.cz/88311). ℹ️\n\nThis repository contains source code of the **server side** of the application. \n\nThe other repository that contains the **client side** of the application can be found [here](https://github.com/itsDaiton/food-square).\n\n⚠️Due to high hosting costs the **application is not available online at the moment**. To view the application, please clone this repository instead and run the application locally.⚠️\n\n![image](https://user-images.githubusercontent.com/72783924/222009100-6076bc96-f99f-4a7c-a3d8-d60eb0c47267.png)\n\n## Features\n\n- **Account**\n  - create account in the application\n  - sign in from multiple devices\n  - edit your account information\n  - upload a profile picture\n  - follow other users\n- **Recipes**\n  - create your own recipes\n    - add ingredients\n    - choose different categories\n  - display details about recipe\n    - meal type\n    - preparation/cooking time\n    - instructions\n    - categories\n    - ingredients and their nutritional values\n  - share your recipe between other users\n  - add recipes to your favorites\n  - filter between recipes based on desired criteria\n- **Reviews**\n  - review other user's recipes\n  - display all existing reviews\n  - sort between best/worst rated recipes\n  - show reviews for a specific recipe\n- **Comments**\n  - add multiple comments to recipes\n- **Ingredients**\n  - display all available ingredients\n  - look up specific ingredients\n- **Liking**\n  - like a comment or a review\n- **Meal planning**\n  - get a generated meal plan based on:\n    - categories\n    - amount of meals\n    - desired calories\n  - save your meal plan\n- **Theming**\n  - switch between light and dark mode\n## Built With\n\n### Programming language\n- [Java 8](https://www.oracle.com/cz/java/technologies/javase/javase8-archive-downloads.html)\n\n### Framework\n- [Spring Boot](https://spring.io/projects/spring-boot)\n\n### Dependency management\n- [Maven](https://maven.apache.org)\n\n### Additional dependencies\n- [Spring Data JPA](https://spring.io/projects/spring-data-jpa) - for building JPA based repositories\n- [Spring Web](https://mvnrepository.com/artifact/org.springframework/spring-web) - for setting up http client and other web oriented features\n- [PostgreSQL JDBC Driver](https://mvnrepository.com/artifact/org.postgresql/postgresql) - for connecting to PostgreSQL database\n- [Lombok](https://projectlombok.org) - for automated class building and removing boilerplate code\n- [Spring Boot Starter Test](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test) - for testing and debugging\n- [Spring Security](https://spring.io/projects/spring-security) - for securing various points of the application\n- [JSON Web Token](https://mvnrepository.com/artifact/io.jsonwebtoken/jjwt) - for JWT support for JVM\n- [Spring Boot Configuration Processor](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor) - for building configuration classes\n- [Spring Boot Starter Validation](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation) - for class and API input validation\n- [Spring Batch](https://spring.io/projects/spring-batch) - for reading and processing external files\n- [springdoc](https://springdoc.org) - for automatic generation of API documentation\n\n\n## Get Started\n\n### Prerequisites\n\n- [Maven](https://maven.apache.org)\n- IDE (e.g. [IntelliJ IDEA](https://www.jetbrains.com/idea/)) or terminal\n\n### Installation\n\nClone the project\n\n```\ngit clone https://github.com/itsDaiton/food-square-api.git\n```\n\nOpen the project\n\n```\ncd food-square-api\n```\n\nConfigure required variables located in `src/main/resources/application.properties`\n\n```\nspring.datasource.url=''\nspring.datasource.username=''\nspring.datasource.password=''\n\napp.jwt.secret-key=''\napp.jwt.expiration-time=''\napp.jwt.cookie-name=''\napp.jwt.secure=''\napp.jwt.sameSite=''\n```\n\n#### spring.datasource.url\n\n- URL to your database, which the application is going to connect to\n\n#### spring.datasource.username\n\n- your username in the database\n\n#### spring.datasource.password\n\n- your password to the database\n\n#### app.jwt.secret-key\n\n- secret used to sign JWT tokens\n\n#### app.jwt.expiration-time\n\n- expiration time on JWT token in milliseconds\n- it is recommended to choose at least 1 day (86400000)\n\n#### app.jwt.cookie-name\n\n- name of the cookie used for user authentication\n- example: 'examplecookiename'\n\n#### app.jwt.secure\n\n- defines whether cookies will have secure attribute or not\n- choose 'false' for local development\n- must be set to 'true' in production!\n\n#### app.jwt.sameSite\n\n- defines whether cookies will have samesite attribute or not\n- choose 'lax' for local development\n- must be set to 'none' in production!\n\nRun the application in terminal\n\n```\nmvnw spring-boot:run\n```\n\nRun the service with curl (in a separate terminal window)\n\n```\ncurl localhost:8080\n```\n\nIf you wish, you can create a executable JAR file\n\n```\nmvnw clean install\n```\n\n### Deployment\n- Create a feature branch for your changes\n- Deploy your code\n- After your development is done, create a pull request\n\n## Contributting\n\nContributions, issues, and feature requests are welcome. If you would like to contribute to this project, please see `CONTRIBUTING`.\n\n## License\n\nProject is distributed under the MIT License. See `LICENSE` for more information.\n\n## Testing\n\nApplication testing was carried out using the [***Postman***](https://www.postman.com) software. Collection of all tests can be found under this directory\n```\ndocs/tests\n```\n\n## Documentation\n\nDocumentation describing all end-points of the API can be found under this URL\n```\n'baseURL'/api/v1/docs/swagger-ui/index.html\n```\n\n## Contact\n\nYou can contact the author of the project under this [e-mail](mailto:david.poslusny@gmail.com).\n\n## Acknowledgments\n\n- Ing. Vojtěch Růžička \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsdaiton%2Ffood-square-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsdaiton%2Ffood-square-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsdaiton%2Ffood-square-api/lists"}