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

https://github.com/zewdu444/catalog_my_things

A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games
https://github.com/zewdu444/catalog_my_things

oop ruby solid sql

Last synced: about 1 year ago
JSON representation

A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
-[:video_camera: Video Presentation](#video-presentation)
- [:camera: screenshot](#screenshot)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📇 Catalog of my things

> This project is console app built using ruby, the app will help you to keep a records of different types of things you own: books, music albums, movies, and games, the data are stored in json file, and it will be always useable whenever you start the app.

## :video_camera: Video Presentation

[![Watch the video](./image/catalog_of_my_things.png)](https://drive.google.com/file/d/1E5rjdrRWB8o-o8q2isNwpAvmmvFhMZT0/view?usp=sharing)

## :camera: Screenshot

## 🛠 Built With

### Tech Stack

- Ruby
- Postgresql

### Key Features

- [Keep track of all things own by a user]
- [Created using ruby to keep a records of different types of things a user own: books, music albums, movies, and games]

(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:

- Command line or terminal
- IDE such as VsCode.
- Ruby needs to be installed on your system.

### Setup

Clone this repository to your desired folder:
Example command:

```sh
git clone https://github.com/zewdu444/catalog_my_things.git
cd catalog_my_things

```

### Install

Example command:

```sh
cd catalog_my_things
bundle install (install all dependencies)

```

### Usage

To run the project redirecting to the root directory of the project and run the following command:

```sh
ruby main.rb (to run console application)

```

### Test

To test the web app run the following command:

```sh
rspec spec ( to test the console application)

```

## 👥 Authors

👤 **zewdu erkyhun**

- GitHub: [zewdu444](https://github.com/zewdu444)
- Twitter: [@zewdu444](https://twitter.com/zewdu444)
- LinkedIn: [zewdu-anley](https://www.linkedin.com/in/zewdu-anley/)

👤 **Mohi**

- GitHub: [@mohisa302](https://github.com/mohisa302)
- Twitter: [@Kholochelam](https://twitter.com/Kholochelam)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mohadese-sadeghi-692551199/)

👤 **Joseph David**

- GitHub: [@jodavid444](https://github.com/jodavid444)
- Twitter:[@jodavid444dave](https://twitter.com/jodavid444dave)
- LinkedIn: [joseph-david-01a8a5243](https://linkedin.com/in/joseph-david-01a8a5243/)

(back to top)

## 🔭 Future Features

- [Add web interface]
- [Improve unit tests]

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/zewdu444/catalog_my_things/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

we would like to thank microverse community for the support and guidance.

(back to top)

## 📝 License

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

(back to top)