[CS2113-T11-3] CliRental

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.clirental.CliRental")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("CliRental")
     archiveClassifier.set("")
 }
 

docs/AboutUs.md

@@ -1,9 +1,18 @@
 # About us
 
+
+Display | Name  |            Github Profile            | Portfolio 
+--------|:-----:|:------------------------------------:|:---------:
+![](/docs/team/Khanh.png) | Khanh | [Github](https://github.com/tkhahns) | [Portfolio](docs/team/johndoe.md)
+
+Display |   Name   |             Github Profile             | Portfolio 
+--------|:--------:|:--------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Rex Koh  | [Github](https://github.com/rexkoh425) | [Portfolio](docs/team/RexKoh.md)
+
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Ryan Fong | [Github](https://github.com/CT9ARyan) | [Portfolio](./team/ryanfong.md)
+
+Display |  Name   |             Github Profile             | Portfolio 
+--------|:-------:|:--------------------------------------:|:---------:
+![](https://avatars.githubusercontent.com/u/94769848?v=4) | Liu Hao | [Github](https://github.com/AaronZZ10) | [Portfolio](./team/liuhao.md)

docs/README.md

@@ -1,6 +1,6 @@
-# Duke
+# CliRental
 
-{Give product intro here}
+Welcome to CliRental, a perfect desktop app dedicate to managing  a car rental business involves handling large volumes of data, making traditional pen-and-paper methods inefficient for managers. This app is designed specifically for car rental managers, offering a Command Line Interface (CLI) that enables quick data entry and efficient tracking of customers, cars, and transactions.
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UserGuide.md

@@ -1,42 +1,68 @@
-# User Guide
+# CliRental User Guide
 
 ## Introduction
 
-{Give a product intro}
+Clirental is a CLI-based application which allows car rental companies 
+to track their customers , cars and rental transactions.
 
 ## Quick Start
 
-{Give steps to get started quickly}
-
 1. Ensure that you have Java 17 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Download the latest version of `CliRental` from [here](https://github.com/AY2425S1-CS2113-T11-3/tp/releases).
 
-## Features 
+## Features
 
-{Give detailed description of each feature}
+### Adding a user to the database: `add-user`
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Adds a customer to the list of customers tracked by the car rental application
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `add-user /u [USERNAME] /a [AGE] /c [CONTACT_NUMBER]`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+* `USERNAME` : `STRING`.
+* `AGE` : `INT`
+* `CONTACT_NUMBER` : `INT`
+* `/u` , `/a` , `/c` must be in sequence.
 
 Example of usage: 
 
-`todo n/Write the rest of the User Guide d/next week`
+`add-user /u John /a 18 /c 95382572`
+
+Sample Response:
+
+```
+____________________________________________________________
+add-user /u John /a 18 /c 95382572
+Customer added
+Username : John
+Age : 18
+Contact Number : 95382572
+What would you like to do?
+____________________________________________________________
+```
+
+### List all cars in the database: `list-cars`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+Lists all the car which the company owns.
+
+Format: `list-cars`
+
+Sample Response:
+
+```
+____________________________________________________________
+list-cars
+Here are the current cars in the company
+1) Toyota Corolla | SGM4932K | $120.0 | Not Rented
+What would you like to do?
+____________________________________________________________
+```
 
 ## FAQ
 
-**Q**: How do I transfer my data to another computer? 
+**Q**: Is there any file saving system in place currently? 
 
-**A**: {your answer here}
+**A**: Unfortunately no , we are currently working on it. Thank you for your patience.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
-
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* Add todo `add-user /u [USERNAME] /a [AGE] /c [CONTACT_NUMBER]`

docs/team/johndoe.md → docs/team/ryanfong.md

@@ -1,4 +1,4 @@
-# John Doe - Project Portfolio Page
+# Ryan Fong - Project Portfolio Page
 
 ## Overview
 

src/main/java/car/Car.java

@@ -0,0 +1,61 @@
+package car;
+
+import exceptions.CarException;
+
+public class Car {
+
+    private String model;
+    private String licensePlateNumber;
+    private double price;
+    private boolean isRented;
+
+    public Car(String model, String licensePlateNumber, double price) throws CarException{
+        this.model = model;
+        this.licensePlateNumber = licensePlateNumber;
+        if (price < 0.00) {
+            throw CarException.invalidPrice();
+        } else {
+            this.price = Double.parseDouble(String.format("%.2f", price));
+        }
+        this.isRented = false;
+    }
+
+    public void setModel(String model) {
+        this.model = model;
+    }
+
+    public String getModel() {
+        return model;
+    }
+
+    public void setLicensePlateNumber(String licensePlateNumber) {
+        this.licensePlateNumber = licensePlateNumber;
+    }
+
+    public String getLicensePlateNumber() {
+        return licensePlateNumber;
+    }
+
+    public void setPrice(double price) {
+        this.price = price;
+    }
+
+    public double getPrice() {
+        return price;
+    }
+
+    public void setRented(boolean isRented) {
+        this.isRented = isRented;
+    }
+
+    public boolean isRented() {
+        return isRented;
+    }
+
+    public String getRentedStatus(){
+        if(isRented){
+            return "Rented";
+        }
+        return "Not Rented";
+    }
+}

src/main/java/car/CarList.java

@@ -0,0 +1,48 @@
+package car;
+
+import java.util.ArrayList;
+
+public class CarList {
+
+    public static ArrayList<Car> carsList = new ArrayList<>();
+
+    public static ArrayList<Car> getCarsList() {
+        return carsList;
+    }
+
+    public static void addCar(Car car) {
+        carsList.add(car);
+        System.out.println("Car added to list");
+        System.out.println("Car details:");
+        System.out.println(car.getModel() + " | " + car.getLicensePlateNumber()
+                + " | $" + car.getPrice() + " | " + car.getRentedStatus());
+    }
+
+    public static void removeCar(String carLicensePlateNumber) {
+        Car carToRemove = null;
+
+        // Iterate through the list of cars to find the one with the given license plate
+        for (Car car : carsList) {
+            if (car.getLicensePlateNumber().equals(carLicensePlateNumber)) {
+                carToRemove = car;
+                break;
+            }
+        }
+
+        // Remove the car if it exists
+        if (carToRemove != null) {
+            carsList.remove(carToRemove);
+            System.out.println("Car with license plate " + carLicensePlateNumber + " removed from list.");
+        } else {
+            System.out.println("No car found with license plate " + carLicensePlateNumber);
+        }
+    }
+    public static void printCarList(){
+        System.out.println("Here are the current cars in the company");
+        for(int i = 0 ; i < carsList.size(); i++){
+            Car car = carsList.get(i);
+            System.out.println( (i + 1) + ") " + car.getModel() + " | " + car.getLicensePlateNumber()
+                    + " | $" +car.getPrice() + " | " + car.getRentedStatus());
+        }
+    }
+}

src/main/java/customer/Customer.java

@@ -0,0 +1,47 @@
+package customer;
+
+/**
+ * Represents customers of CliRental
+ */
+public class Customer {
+
+    private String username;
+    private int age;
+    private int contactNumber;
+
+    public Customer(String username, int age, int contactNumber){
+        this.username = username;
+        this.age = age;
+        this.contactNumber = contactNumber;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public int getContactNumber() {
+        return contactNumber;
+    }
+
+    public int getAge() {
+        return age;
+    }
+
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public void setAge(int age) {
+        this.age = age;
+    }
+
+    public void setContactNumber(int contactNumber) {
+        this.contactNumber = contactNumber;
+    }
+
+    public String toString(){
+        return "Username : " + this.getUsername() + "\n"
+                + "Age : " + this.getAge() + "\n"
+                + "Contact Number : " + this.getContactNumber();
+    }
+}

src/main/java/customer/CustomerList.java

@@ -0,0 +1,36 @@
+package customer;
+
+import java.util.ArrayList;
+
+public class CustomerList {
+
+    public static ArrayList<Customer> customers = new ArrayList<>();
+
+    public static void addCustomer(Customer customer){
+        customers.add(customer);
+        System.out.println("Customer added");
+        System.out.println(customer.toString());
+    }
+
+    public static boolean removeCustomer(String username){
+        for(Customer customer : customers){
+            if(customer.getUsername().equals(username)){
+                customers.remove(customer);
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public static ArrayList<Customer> getCustomers() {
+        return customers;
+    }
+
+    public static void printCustomers() {
+        for (Customer customer : customers) {
+            System.out.println(customer.toString());
+            System.out.println("____________________________________________________________");
+        }
+    }
+}
+

src/main/java/exceptions/CarException.java

@@ -0,0 +1,22 @@
+package exceptions;
+
+public class CarException extends RuntimeException{
+
+    private static final String ADD_CAR_FORMAT = "add-car /n [CAR_MODEL] /c [CAR_ID] /p [PRICE]";
+
+    public CarException(String message) {
+        super(message);
+    }
+
+    public static CarException addCarException() {
+        String message = "Unable to add car.. Refer to correct format below:\n" +
+                ADD_CAR_FORMAT;
+        return new CarException(message);
+    }
+
+    public static CarException invalidPrice() {
+        String message = "Unable to add car.. Price cannot be negative!!";
+        return new CarException(message);
+    }
+
+}

src/main/java/exceptions/CliRentalException.java

@@ -0,0 +1,10 @@
+package exceptions;
+
+public class CliRentalException extends Exception {
+    public CliRentalException(String message) {
+        super(message);
+    }
+    public static CliRentalException unknownCommand() {
+        return new CliRentalException("OOPS!!! Invalid command!");
+    }
+}

src/main/java/exceptions/CustomerException.java

@@ -0,0 +1,24 @@
+package exceptions;
+
+/**
+ * Customer related exceptions
+ */
+public class CustomerException extends RuntimeException {
+
+    public static final String ADD_FORMAT = "add-user /u [USERNAME] /a [AGE] /c [CONTACT_NUMBER]";
+
+    public CustomerException(String message) {
+        super(message);
+    }
+
+    public void printErrorMessage(){
+        System.out.println(getMessage());
+    }
+
+    /**
+     * Exception for the add-user command
+     */
+    public static CustomerException addCustomerException(){
+        return new CustomerException("Unable to add customer. Please follow : " + ADD_FORMAT);
+    }
+}