Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaron-kristopher/javafx-cafe-pos
☕ A simple Point Of Sale (POS) System implemented using javafx
https://github.com/aaron-kristopher/javafx-cafe-pos
java javafx javafx-application javafx-gui
Last synced: about 2 months ago
JSON representation
☕ A simple Point Of Sale (POS) System implemented using javafx
- Host: GitHub
- URL: https://github.com/aaron-kristopher/javafx-cafe-pos
- Owner: aaron-kristopher
- Created: 2023-10-31T13:48:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-02T15:30:59.000Z (12 months ago)
- Last Synced: 2024-10-12T18:41:01.162Z (3 months ago)
- Topics: java, javafx, javafx-application, javafx-gui
- Language: Java
- Homepage:
- Size: 840 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CAFE POS SYSTEM
Welcome to **Artisan Delight**, a fictional cafe celebrated for its delectable food, beverages, and delightful desserts. In an effort to enhance the cafe's operational efficiency, I have developed a **Point of Sale (POS) System**. This system serves the purpose of managing customer orders and seamlessly generates transaction receipts. I have thoughtfully designed a user-friendly interface that allows users to explore Artisan Delight's extensive menu offerings. This project was meticulously crafted to fulfill the requirements of our _CIT10333P Midterm project_.
## Table of Contents
- [Folder Structure](#folder-structure)
- [Dependencies](#dependencies)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Folder Structure
The workspace contains five folders within the src directory, where:
- `logic`: contains all Java logic for the POS classes, excluding UI elements.
- `controller`: stores JavaFX controller classes.
- `ui`: includes FXML files and the POS UI.
- `img`: used for storing UI assets.
- `styles`: contains CSS files for styling.
Meanwhile, the `App.java` serves as the main Java file and runs the entire program.
## Dependencies
This project utilizes the following dependency:
- [JavaFX -version 21.0.1](https://openjfx.io/): JavaFX allows you to create Java applications with a modern, hardware-accelerated user interface that is highly portable.
## Getting Started
To get started with this POS system, follow these steps:
1. Clone the repository to your local machine using HTTPS
```bash
git clone https://github.com/aaron-kristopher/javafx-cafe-pos.git
```
2. Open the project in your preferred Java development environment (e.g., IntelliJ IDEA, Eclipse).
3. Build and run the project to start the Artisan Delight POS System.
## Usage
Once the project is running, you can:
- Browse the menu items.
- Place orders.
- Generate transaction receipts.
Feel free to explore and use the system as needed.
## Contributing
If you'd like to contribute to this project, please follow these steps:
1. Fork the repository on GitHub. [Git Clone Link](https://github.com/aaron-kristopher/javafx-cafe-pos.git)
2. Open the project in your preferred Java development environment (e.g., IntelliJ IDEA, Eclipse).
3. Build and run the project to start the Artisan Delight POS System.
## Usage
Once the project is running, you can:
- Browse the menu items.
- Place orders.
- Generate transaction receipts.
Feel free to explore and use the system as needed.
## Contributing
If you'd like to contribute to this project, please follow these steps:
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your contribution.
4. Make your changes, commit them, and push the changes to your GitHub repository.
5. Create a pull request to the original repository for review.
We welcome contributions and appreciate your help in making this project even better!
## License
This project is licensed under the [UNOR License](LICENSE). You are free to use, modify, and distribute it as per the terms of the license.
---
Enjoy using the Artisan Delight POS System! If you have any questions or encounter issues, please don't hesitate to reach out.