https://github.com/tennyros/make-it-healthy
Nutrition Tracking REST API
https://github.com/tennyros/make-it-healthy
jacoco java-17 junit5 liquibase mapstruct maven mockito postgresql rest-api spirng-data-jpa-hibernate spring-boot swagger-ui
Last synced: about 2 months ago
JSON representation
Nutrition Tracking REST API
- Host: GitHub
- URL: https://github.com/tennyros/make-it-healthy
- Owner: tennyros
- License: mit
- Created: 2025-04-05T05:37:40.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2025-04-14T18:51:00.000Z (about 1 year ago)
- Last Synced: 2025-06-21T10:46:12.678Z (12 months ago)
- Topics: jacoco, java-17, junit5, liquibase, mapstruct, maven, mockito, postgresql, rest-api, spirng-data-jpa-hibernate, spring-boot, swagger-ui
- Language: Java
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Make it Healthy
**Make It Healthy** is a REST API service for tracking daily calorie intake and user diet.
## Tech Stack
| Component | Version | Purpose |
|---------------------------------|---------|--------------------------------------------------|
| Spring Boot | 3.4.4 | Backend framework |
| Hibernate ORM (Spring Data JPA) | 6.6.11 | ORM framework for managing Java persistence with |
| Maven (wrapper) | 3.9.9 | Project build tool |
| PostgreSQL | 15+ | Database management system |
| Liquibase | 4.31.1 | Database migrations |
| MapStruct | 1.6.3 | Object mapping (DTO/Entity) |
| JUnit 5 | 5.11.4 | Test framework for unit tests |
| Mockito | 5.14.2 | Test framework for mocking in unit tests |
| JaCoCo | 0.8.13 | Test coverage reports |
| Springdoc OpenAPI | 2.8.6 | API documentation (Swagger UI for Spring) |
## Project Structure
```text
Source code structure (dev branch):
src/
├── main/
│ ├── java/
│ │ └── com/github/tennyros/makeithealthy/
│ │ ├── config/ # Configurations
│ │ ├── dto/ # Data Transfer Objects
│ │ │ ├── request/ # Request DTOs
│ │ │ └── response/ # Response DTOs
│ │ │ └── reporting/ # Report DTOs
│ │ ├── entity/ # Data models
│ │ ├── exception/ # Own exceptions
│ │ ├── http/ # REST API
│ │ │ ├── advice/ # Exception Handlers
│ │ │ └── rest/ # REST Controllers
│ │ ├── mapper/ # MapStruct mappers
│ │ ├── repository/ # Data Access Objects
│ │ └── service/ # Business logic
│ └── resources/
│ ├── db/changelog/ # Liquibase migrations
│ ├── application.yml # Main configuration
│ ├── application-dev.yml # Development configuration
│ └── application-prod.yml # Production configuration
├── test/
│ ├── java/
│ │ └── com/github/tennyros/makeithealthy/
│ │ └── unit/ # Unit tests
│ │ ├── controller/ # Controller layer unit tests
│ │ └── service/ # Service layer unit tests
│ └── resources/
│ └── application-test.yml # Test configuration
├── postman/ # json Postman API test collection
pom.xml
Build artifacts:
target/
├── generated-sources/
│ ├── annotations/
│ │ └── com.github.tennyros.makeithealthy.mapper/ # Auto-generated MapStruct classes
├── reports-report/ # JaCoCo coverage reports
```
## Quick Start
### Prerequisites
1. **Java 17+**
2. **PostgreSQL 15+** (local, remote or docker container instance)
3. **Maven 3.9.9** (wrapper included)
### Setup
**1. Clone the repository:**
```bash
git clone https://github.com/tennyros/make-it-healthy.git
cd make-it-healthy
```
**2. Copy the .env file and change the credentials if necessary:**
```bash
cp .env.example .env
```
**3. Run PostgreSQL via Docker (optional, if you don’t run own DB):**
```bash
# Copy the example config (if not customized yet)
cp docker-compose.example.yml docker-compose.yml
# Start PostgreSQL in Docker
docker-compose up -d
If using docker-compose, PostgreSQL will be available at
localhost:5433 (default credentials: postgres/root).
If you already have PostgreSQL, ensure application.yml/.env matches your DB settings.
```
**4. Application build:**
```bash
./mvnw clean install -Dspring.profiles.active=dev
```
**5. Run the application:**
```bash
# Run via terminal:
./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
# Run via Intellij Idea (Shift + F10):
Type dev in Active profiles Edit Configurations of main class to setup profile
Application port is 8008
```
**After this, the API will be available at:**
```url
http://localhost:8008/swagger-ui.html
```
## Testing
**Test types:**
```text
unit/ - Unit tests
```
**Running tests:**
```bash
# All tests
./mvnw test -Dspring.profiles.active=test
# Run a specific test
./mvnw test -Dspring.profiles.active=test -Dtest=YourTestName
```
## API Testing with Postman
You can test and explore the API using the included Postman collection.
### Included File
- **make-it-healthy-app.postman_collection.json** – API requests for user, meal, food intake, and reporting operations.
### How to Use
1. Install Postman – [Download here](https://www.postman.com/downloads/).
2. Open Postman → `File > Import` → Choose the `make-it-healthy-app.postman_collection.json` file.
3. Click on the variable `{{url}}` in any request and set it to your running API base URL (e.g., `http://localhost:8008`).
4. Click **Send** to test endpoints.
> ℹ️ The collection already includes the `{{url}}` variable pointing to `http://localhost:8008`. You can edit it if needed.
## CI Pipeline
```text
The project is set up with CI to automatically build
and test on pull requests using GitHub Actions.
```