Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ansaribrahim/catalogmythings

CatalogMyThings: A Ruby-based catalog app to manage and organize your books, music, and games with labels and genres.
https://github.com/ansaribrahim/catalogmythings

gem gemfile gemfile-lock linters rspec rubocop ruby ruby-gem sql test

Last synced: 26 days ago
JSON representation

CatalogMyThings: A Ruby-based catalog app to manage and organize your books, music, and games with labels and genres.

Awesome Lists containing this project

README

        



# CatalogMyThings

![e2954fb3deb2407e8e4bcb40b1fd6376](https://github.com/AnsarIbrahim/LeaderBoard-new/assets/117971223/9d715e43-a095-4b33-b5f2-161236e8fdcc)

# 📗 Table of Contents

- [📗 Table of Contents](#-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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📚 CatalogMyThings 🎵🎮

CatalogMyThings is a Ruby-based cataloging application that helps you organize your collection of books, music albums, and games. 📖🎶🎮 It allows you to create, manage, and categorize items using labels and genres. 🏷️📚🎶 With an intuitive command-line interface, you can easily add, list, and archive items in your collection. 📁✨

## 🛠 Built With

### Tech Stack

Ruby

IDE

### Key Features

- **Add and manage books, music albums, and games.**
- **Assign labels and genres to categorize your items.**
- **Archive items based on publish date or condition.**
- **User-friendly command-line interface for easy navigation.**
- **Data persistence using JSON files.**
- **Simple and efficient organization of your personal catalog.**
- **Gemfile**
- **Rubocop**
- **Gemfile.lock**
- **Unit Testing**
- **license**

(back to top)

## 🚀 Live Demo

- [Video Walkthrough](https://drive.google.com/file/d/15OBO1C9OyyNLsacCb2IwOgVZYRwkVLzW/view?usp=sharing)

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

```
install ruby
```

### Setup

Clone this repository to your desired folder:

```
cd my-folder git clone [email protected]:AnsarIbrahim/My_Things-Ruby-Capstone.git
```

### Install

Install this project with:

```sh
cd my-project
gem install
```

### Usage

To run the project, execute the following command:

- Clone the repository.
- Run ruby `main.rb` to start the application.
- Use the menu to add, list, and archive items.
- Enjoy effortless cataloging and organization!

### Run tests

To run tests, run the following command:

```sh
RSpec
```

### Deployment

You can deploy this project using in Local Machine:

```sh
ruby main.rb
```

(back to top)

## 👥 Authors

👤 **Ansar Ibrahim**

- [GitHub](https://github.com/AnsarIbrahim)
- [LinkedIn](https://linkedin.com/in/ansar-ibrahim/)
- [Twitter](https://twitter.com/ansaradheeb)

👤 **Md. Porag Sarkar**

- GitHub: [@porag-m06](https://github.com/porag-m06)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/muhammad-porag-nsu-cse/)

(back to top)

## 🔭 Future Features

- **Create Movie**
- **Create Source**
- **List all movies**
- **List all sources (e.g. 'From a friend', 'Online shop')**
- **Add a movie**
- **Deployment**

(back to top)

## 🤝 Contributing

- Contributions, issues, and feature requests are welcome!
- Feel free to open issues or pull requests for bug fixes or enhancements.
- Follow the code of conduct and contribution guidelines.

Feel free to check the [issues page](https://github.com/AnsarIbrahim/My_Things-Ruby-Capstone/issues).

(back to top)

## ⭐️ Show your support

If you like this project give it a ⭐️

(back to top)

## 🙏 Acknowledgments

- Microverse and my coding partner [Md. Porag Sarkar](https://github.com/porag-m06) 💖💖

(back to top)

## 📝 License

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

(back to top)