🚀 Breakable Toy I

An inventory management application, this web application make use of Spring Boot and Maven for Backend tasks and ReactJS with Vite for the frontend.

📌 Content

• Technologies
• Requirements
• Installation
• Configuration
• Execution
• Testing

🛠 Technologies

Backend (Spring Boot)

• Java 17
• Spring Boot 3.5.0
• Spring Web (REST API)
• Springdoc OpenAPI (Swagger UI for API documentation)
• Maven (Build and dependency manager)
• JUnit (Service methods testing)

Frontend (React.js + Vite)

• React 19
• TypeScript
• Vite (build tool & dev server)
• Tailwind CSS
• Jest (Testing)
• Several component depedencies (React Select, React Datepicker, TanStack react-table, Radix UI, Lucide React, etc...)

📋 Requirements

• JDK 17+ (Backend)
• Maven 3.9.10+
• Node.js 22.16+ (Frontend)

⚙ Installation

# Clone repository
https://github.com/AlexJauregui02/BreakableToyI.git

Backend

# From the initial folder
# Go to the backend directory
cd backend

# Install dependencies
mvn clean install

Frontend

# From the initial folder
# Go to the frontend directory
cd frontend

# Install dependencies
npm install

🔧 Configuration

Backend

Create application.properties in src/main/resources:

# Add configuration data like username or the databse url
spring.application.name=java-backend
spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
server.port=9090

Frontend

Create .env in the frontend root:

# Add necesary information, in this case the next URL should be fine
VITE_BACKEND_API_URL="http://localhost:9090/api"

🚀 Execution

Backend

# Start running the backend
mvn spring-boot:run

Frontend

# Start running the frontend
npm run start

Access:

• Backend: http://localhost:9090
• Frontend: http://localhost:8080

🧪 Testing

Backend (Spring Boot)

# Run unit tests (Junit)
mvn test

To try the API's available, use the link generated by swagger: http://localhost:9090/swagger-ui/index.html

Frontend

# Run unit tests (Jest)
npm run test