Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix website landing page #195

Merged
merged 1 commit into from
Apr 15, 2024
Merged

Fix website landing page #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions docs/index.md
View file
Open in desktop
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)
Loading