https://github.com/clembs/blumbat

Real estate app for college, leveraging Java Swing. Mirror of the private college GitLab repository.
https://github.com/clembs/blumbat

Last synced: 3 days ago
JSON representation

Real estate app for college, leveraging Java Swing. Mirror of the private college GitLab repository.

• Host: GitHub
• URL: https://github.com/clembs/blumbat
• Owner: Clembs
• Created: 2024-12-18T10:10:14.000Z (4 days ago)
• Default Branch: main
• Last Pushed: 2024-12-18T13:51:04.000Z (4 days ago)
• Last Synced: 2024-12-18T14:48:58.228Z (4 days ago)
• Language: Java
• Homepage:
• Size: 8.66 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-en.md

Awesome Lists containing this project

README

        
# BlumBat

Real estate application for landlords. Student projet for IUT Paul Sabatier (SAÉ S3.A.01).

[GitHub mirror](https://github.com/Clembs/BlumBat) | [README original en Français](README.md)

## Prerequisites

- [Java Development Kit (JDK) 8](https://adoptium.net/temurin/releases/?version=8)

- [Apache Maven](https://maven.apache.org/download.cgi) ([Windows how-to](https://phoenixnap.com/kb/install-maven-windows))

- A MySQL database

## Installation and exécution

### Configuring the database

1. Create a MySQL database

2. Execute the script in `sql/create_tables.sql` to create the required tables

3. Created a `.env` file at the project root, and add the following database credentials:

```properties

DATABASE_URL = "jdbc:mysql://[host]:[port]/[database name]"

DATABASE_USER = "[username]"

DATABASE_PASSWORD = "[password]"

```

### Compiling and executing

```bash

$ mvn clean compile # To compile a .jar

$ mvn exec:java # To run the application

$ mvn clean compile exec:java # To do both in one command

```

### Run unit tests

```bash

$ mvn clean test

```

## Project structure

- `sql`: Migrations and other SQL scripts

- `src/controller`: Application controllers

- `src/dao`: Data Access Objects for model classes

- `src/db`: Database connection

- `src/model`: Abstract Java classes for database tables

- `src/view` : Application windows, panels and pop-ups