Skip to content

Commit 6ebb92a

Browse files
committed
Add README.md
1 parent f88962b commit 6ebb92a

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Simple Inventory Management System
2+
3+
**Description:** In this console-based application, you'll create a basic inventory management system. This system will
4+
allow a user to manage a list of products, where each product has a name, price, and quantity in stock.
5+
6+
**GitHub requirements:** You must use Git for version control and host your project on GitHub. Commit and push your
7+
changes to GitHub at the end of each phase, with meaningful commit messages describing what you have implemented in each
8+
commit.
9+
10+
Here are the main functionalities the system should have:
11+
12+
1. **Add a product:** Prompt the user for the product name, price, and quantity, then add the product to the inventory.
13+
*Commit the changes and push them to GitHub.*
14+
2. **View all products:** Display a list of all products in the inventory, along with their prices and quantities.
15+
*Commit and push.*
16+
3. **Edit a product:** Ask the user for a product name. If the product is in the inventory, allow the user to update its
17+
name, price, or quantity. *Commit and push.*
18+
4. **Delete a product:** Ask the user for a product name. If the product is in the inventory, remove it. *Commit and
19+
push.*
20+
5. **Search for a product:** Ask the user for a product name. If the product is in the inventory, display its name,
21+
price, and quantity. If not, let the user know the product was not found. *Commit and push.*
22+
6. **Exit:** Close the application. *Final commit and push.*
23+
24+
For this project, you'll want to create a **`Product`** class with the appropriate properties (name, price, quantity)
25+
and methods. You'll also want to create an **`Inventory`** class which maintains a list of **`Product`** objects and
26+
provides methods for adding, deleting, and editing products.
27+
28+
This will give you practice with object-oriented programming, basic data structures (like lists), user input/output,
29+
control flow, and version control using Git and GitHub.

0 commit comments

Comments
 (0)