Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tobuya/catalog_of_my_things

Here, we have created a console app that will help us to keep a record of different types of things we own: books, music albums, movies, and games. Built using Ruby.
https://github.com/tobuya/catalog_of_my_things

postgresql rspec ruby unit-testing

Last synced: 2 days ago
JSON representation

Here, we have created a console app that will help us to keep a record of different types of things we own: books, music albums, movies, and games. Built using Ruby.

Awesome Lists containing this project

README

        

Catalog Of My Things

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Catalog Of My Things

**Catalog of my things** is a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. The data will be stored in JSON files but we will also prepare a database with tables structure analogical to your program's class structure.

## 🛠 Built With

### Tech Stack

Client

Technology

Database

### Key Features

- **Present the user with a list of options to choose and perform.**
- **Allow users to enter the parameter for their option**
- **Preserve data by saving collections in .json files**
- **Present a way for the users to quit the app**

(back to top)

## 🚀 Video Demo

- [Click Here To View Live](https://drive.google.com/file/d/1y8INxgxfKhlF7uADXs4XbN86ghBsP5Hy/view?usp=share_link)

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

```sh
sudo apt-get install ruby-full
```

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone [email protected]:tobuya/catalog_of_my_things.git
```

### Install

Install this project with:

Example command:

```sh
cd catalog_of_my_things.git
gem install
```

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

### Run tests

To run tests, run the following command:

```sh
rspec --pattern spec/*_spec.rb
```

### Deployment

You can deploy this project on the console using:

```sh
ruby main.rb
```

(back to top)

## 👥 Authors

👤 **Thomas Obuya**

- GitHub: [@githubhandle](https://github.com/tobuya)
- Twitter: [@twitterhandle](https://twitter.com/MullerTheGreat1)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tobuya/)

👤 **Pray Eddy Shimwa**

- GitHub: [@githubhandle](https://github.com/EddyShimwa)
- Twitter: [@twitterhandle](https://twitter.com/pray_eddy)
- LinkedIn: [LinkedIn](https://linkedin.com/in/pray-eddy-shimwa-18a6751b6/)

👤 **Ajayi Ridwan**

- GitHub: [@githubhandle](https://github.com/Ridwanullahi-code)
- Twitter: [@twitterhandle](https://twitter.com/Ridwanullahi22)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ajayi-ridwan-2a1515199/)

(back to top)

## 🔭 Future Features

- [ ] **Add more classes**
- [ ] **Implement more features**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project give it a star ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank fellow Micronauts.

(back to top)

## 📝 License

This project is [MIT](https://github.com/tobuya/catalog_of_my_things/blob/dev/Licence) licensed.

(back to top)