Le P'tit Bazar
a store management software using Java & SQL

Note

Readme également disponible en français

About

This project, developed in both Java and SQL (PostgreSQL), is a medium-sized grocery store management software. It allows for stock management, customer management (loyalty program, etc.), and employee management (by the manager).

Roadmap

A roadmap with features to be implemented and progress is available here (in French only).

Table of contents

1. About
2. Roadmap
3. Table of contents
4. Installation
   • Prerequisites
   • Build
5. Usage
6. Technological stack
   • Development
   • Dependencies
   • User interface (GUI)
   • Database
   • Design
7. Database structure
8. License information

Installation

Prerequisites

• Java 11 or higher (JDK)
• Docker (for the database)

Build

1. Clone the repository

   git clone https://github.com/maxoux53/petit-bazar.git
   cd petit-bazar

2. Set up environment variables
   Configure the following variables:

   • PG_USER: Database username
   • PG_PASSWORD: User password for the database
   • PG_DB: Database name
   • STORE_NAME: Store name (displayed in the GUI)

   You can use the .env template file, simply rename it to .env and edit the values as wanted.

3. Database configuration

   • Use the compose command to create the PostgreSQL container

     docker compose up -d

4. Run the software

   • Open the project in IntelliJ
   • Run the Main class to start the app

   You can also compile the project yourself with javac.

Usage

(...)

Technological stack

Development

• Java
• OpenJDK
• IntelliJ build system

Dependencies

• Dotenv
• PostgreSQL JDBC Driver

User interface (GUI)

• JFC Swing
• AWT

Database

• PostgreSQL
• Docker
• DataGrip & Azure Data Studio (for development)

Design

• Draw.io for the database design (ER & relational schemas)

Database structure

Important

Schemas are only visible with the light theme!

Entity-Relationship (ER) diagram

Relational schema

License information

Contribution and credit

This project is developed by Constant B., Adrien D. and Max N. as part of the 'Programmation orientée objet avancée' (Advanced Object-Oriented Programming) course (IG252).
The project name is inspired by Tisdo's illustrious Grand Bazar.

License

This project is licensed under the GNU GPL v3. For more details, please refer to the LICENSE file.