Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fmanimashaun/catalog_of_items

Catalog of My Things is a Ruby group capstone project focused on creating a console app for managing collections of items such as books, music albums, movies, and games. The project emphasizes SQL database integration, UML class diagram implementation, and collaborative group work.
https://github.com/fmanimashaun/catalog_of_items

rspec rspec-testing ruby ruby-app ruby-oop unittest

Last synced: 14 days ago
JSON representation

Catalog of My Things is a Ruby group capstone project focused on creating a console app for managing collections of items such as books, music albums, movies, and games. The project emphasizes SQL database integration, UML class diagram implementation, and collaborative group work.

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)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

## 📖 Catalog of My Things command-Line App

**Catalog of My Things** is a Ruby group capstone project focused on creating a console app for managing collections of items such as books, music albums, movies, and games. The project emphasizes SQL database integration, UML class diagram implementation, and collaborative group work.

## 🛠 Built With

- Ruby

### Tech Stack

Server


  • Ruby

Test Suite


  • Rspec

### Key Feature

- Implement classes based on the provided UML class diagram.
- Set up associations and aggregations between classes.
- Define and set up properties in the constructor method.
- Implement specified methods for each class.
- Create a console app with options to list items, genres, labels, authors, sources, and add items.
- Preserve data by saving collections in .json files.
- Create an SQL schema analogical to the class structure for future data storage.

👆

## 💻 Getting Started

To get started with the project, follow the steps below.

### Prerequisites

To run this project, ensure you have the following installed:

- [Git](https://git-scm.com/)
- [Ruby](https://www.ruby-lang.org/en/)
- A code editor (e.g., [VsCode](https://code.visualstudio.com/))

### Setup

Clone the repository to your local machine:

```bash
git clone https://github.com/fmanimashaun/catalog_of-items.git

cd catalog_of_items

bundle install
```

### Usage

To run the program, you can use a Ruby interpreter. For example, to interact with the code, use the following:

```bash
ruby './main.rb'
```

Then, load the required files and start using the classes.

👆

## 👥 Authors

👤 **Fisayo Michael Animashaun**

- GitHub: [@fmanimashaun](https://github.com/fmanimashaun)
- Twitter: [@fmanimashaun](https://twitter.com/fmanimashaun)
- LinkedIn: [Fisayo Michael Animashaun ](https://linkedin.com/in/fmanimashaun)

👆

## 🔭 Future Features

- implement database

👆

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

[Issue Page](https://github.com/fmanimashaun/catalog_of_items/issues)

👆

## ⭐️ Show your support

If you like this project leave a start for it.

👆

## 🙏 Acknowledgments

I'd like to thank Microverse for helping us in the journey to become a Fullstack developer.

👆

## 📝 License

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

👆