An open API service indexing awesome lists of open source software.

https://github.com/geekelo/personal-inventory

A ruby app to keep personal inventory records
https://github.com/geekelo/personal-inventory

cli-app ruby

Last synced: 5 months ago
JSON representation

A ruby app to keep personal inventory records

Awesome Lists containing this project

README

          




logo

PERSONAL INVENTORY CONSOLE APP

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 PERSONAL INVENTORY ](#-personal-inventory-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Video Presentation ](#video-presentation-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 PERSONAL INVENTORY

**PERSONAL INVENTORY CONSOLE APP** is a t a simple console app built with Ruby that allows users to manage collections of the movies, games, music albums and books they own.
This project is based on the following UML class diagram.

![Alt text](image.png)

## 🛠 Built With

### Tech Stack

Ruby

### Video Presentation
[See Video](https://drive.google.com/file/d/1p01lZr5ACIx3p_ULbuULAGKr54G_LlRQ/view?usp=sharing)

### Key Features

- **Presents the user with a list of options to perform.**
- **Let users choose an option.**
- **If needed, asks for parameters for the option.**
- **Has a way to quit the app.**

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Code editor like VS code
- Ruby installed in your machine

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/geekelo/personal-inventory_project.git
```

### Install

Install this project with:

```sh
cd personal-inventory
bundle install
```

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

(back to top)

## 👥 Authors

👤 **Eloghene Otiede**

- GitHub: [@githubhandle](https://github.com/geekelo)
- Twitter: [@twitterhandle](https://twitter.com/geekelo_xyz)
- LinkedIn: [LinkedIn](https://linkedin.com/in/eloghene-otiede)

👤 **Melkamu Almawu**

- GitHub: [@melkamu12](https://github.com/melkamu12)
- Facebook: [@Melkamu Almawu](https://www.facebook.com/people/Melkamu-Almawu/pfbid028hQsqdkxPj8AuN9RFqvCFArmhEP2kcaFNRPL5X8Cri14ZTStjVNPNj2kevtq8GSJl/)
- LinkedIn: [Melkamu Almawu](https://www.linkedin.com/in/melkamu-almawu/)

👤 **Chandan Gupta**

- GitHub: [@Chandan-devs-tech](https://github.com/Chandan-devs-tech)
- Twitter: [@ChandanGuptaDev](https://twitter.com/ChandanGuptaDev)
- LinkedIn: [@chandangupta-devs](https://www.linkedin.com/in/chandangupta-devs)

👤 **Ayomide Emmanuel**

- GitHub: [@Paulinelali](https://github.com/Paulinelali)
- Twitter: [@ayomide-emmanuel](https://www.linkedin.com/in/ayomide-emmanuel-1353b31b9/)
- LinkedIn: [@ayomide-emmanuel](https://www.linkedin.com/in/ayomide-emmanuel-1353b31b9/)

(back to top)

## 🔭 Future Features

- [ ] **Add Delete options**
- [ ] **Add edit options**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/geekelo/unibek-school_library_app/issues).

(back to top)

## ⭐️ Show your support

If you like this project drop a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank from Microverse for adding the guidlines of project.

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)