Skip to content

Commit

Permalink
Merge pull request #195 from billyhoce/final-bug-fix
Browse files Browse the repository at this point in the history
Fix website landing page
  • Loading branch information
billyhoce authored Apr 15, 2024
2 parents 2d124ee + 18272f6 commit 89e80fb
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
---
layout: page
title: AddressBook Level-3
title: SweetRewards
---

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)

![Ui](images/Ui.png)

**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
# SweetRewards

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
Welcome to **SweetRewards**, the premier desktop application designed to help small and medium-sized bakery owners efficiently manage their customer loyalty programs. By integration the use of a command-line interface (CLI), we give you the power to control your very own loyalty points systems through an easy-to-use command system!

## Key Features

**Acknowledgements**
- **Member Management**: Add, edit, and manage member details effortlessly.
- **Points and Membership Tiers**: Track purchases, manage reward points, and update membership tiers with ease.
- **Order and Catalogue Management**: Seamlessly manage your bakery's product catalogue and customer orders.
- **Data Management**: Automatic saving, with options for manual editing and archiving.

## Getting Started

1. **Installation**: Ensure your device has Java 11 or higher, and download the latest version of SweetRewards.
2. **Initialization**: Use the `seedData` command to populate your application with sample data, or start adding your members with `addmem`.
3. **Explore Features**: Dive into managing your loyalty program with features like `addorder`, `redeempoints`, and more.

* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

0 comments on commit 89e80fb

Please sign in to comment.