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

https://github.com/jugosack/catalog_my_things_ruby

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.
https://github.com/jugosack/catalog_my_things_ruby

json postgresql ruby

Last synced: 2 months ago
JSON representation

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.

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. It keeps a records of different things:

- books
- music
- albums
- movies
- games

Data are stored in json file and could be used whenever you start the app.

## :video_camera: Video Presentation

[![Watch the video]()](https://drive.google.com/file/d/1sedihGIc42GPd74Lh8bfOVkaGRsjjq4Q/view?usp=sharing)

## :camera: Screenshot




## 🛠 Built With

### Tech Stack

- Languages: Ruby
- Postgresql
- Frameworks: N/A
- Technologies Used: GIT, GITHUB, LINTERS

### 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/jugosack/catalog_my_things_Ruby
cd catalog_my_things

```

### Install

Example command:

```sh
cd catalog_my_things_Ruby
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

👤 **Jugoslav Achkoski**

- GitHub: [@github](https://github.com/jugosack)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/jugoslavachkoski/)
- Twitter: [twitter](https://twitter.com/Jugoslav_A)
- Facebook: [facebook](https://www.facebook.com/jugoslav.ackoski/)

👤 **Uchechi Nwaka**

- -- GitHub: [@uchexm](https://github.com/uchexm)
- -- LinkedIn: [@nwakauc](https://www.linkedin.com/in/nwakauc/)
- -- Twiter [@nwakauc](https://twitter.com/Nwakauc)

👤 **Damilare Arikeusola**

- GitHub: [@mrprotocoll](https://github.com/mrprotocoll)
- Twitter: [@dprotocoll](https://twitter.com/dprotocoll)
- LinkedIn: [@mrprotocoll](https://www.linkedin.com/in/mrprotocoll)

(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/jugosack/catalog_my_things_Ruby/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)