Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/baqar-abbas/rubycapstone-catalog-of-things

This project is console Ruby app built with a team of three developers in collaboration. It allows users to store musics, books, and games and the data has been preserved in a JSON files and it is being retrived and populated back to the user by selecting the right options from the list of menu provided. in the console app
https://github.com/baqar-abbas/rubycapstone-catalog-of-things

Last synced: about 21 hours ago
JSON representation

This project is console Ruby app built with a team of three developers in collaboration. It allows users to store musics, books, and games and the data has been preserved in a JSON files and it is being retrived and populated back to the user by selecting the right options from the list of menu provided. in the console app

Awesome Lists containing this project

README

        

logo


Catalog of Things


Ruby app for storing favourite Books, Music Albums or Games.
You can also add a new book, music album or game.

# 📗 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)
- [Tests](#tests)
- [👥 Authors](#authors)
- [🔮 Future features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 About the project

This project is console Ruby app built with a team of three developers in collaboration. It allows users to store musics, books, and games and the data has been preserved in a JSON files and it can be retrived and populated back to the user by selecting the options from the list of menu provided in the console app.

## 🛠 Built With

### Tech Stack

html5

### Key Features

- **[Console menu]**
- **[Add label and book]**
- **[Add genre and music album]**
- **[Add author and game]**
- **[Unit test]**
- **[Save data in file]**
- **[Load data from file]**

(back to top)

## 🚀 Live Demo

- [Video Presentation Link](https://drive.google.com/file/d/1UmLochYUZwS5Arbar6N1Bsbz3RMEchVc/view)

(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. To install ruby in your machine you can follow the steps listed in the [Ruby installation instructions guide](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)

### Setup

Clone this repository to your desired folder:
```
cd rubyCapstone-catalog-of-things
git clone [email protected]:baqar-abbas/rubyCapstone-catalog-of-things.git
```
### Install

Install this project with:

for now you don't need any installation to run project if you already followed [Prerequisites](#prerequisites)

and
```
bundle install

```

### Usage

To start the app, run the command:
```
ruby main.rb
```

### Run tests

To run tests, run the following command:

```
rspec spec

```

(back to top)

## 👥 Authors

👤 **Baqar Abbas**

- GitHub: [@Baqar](https://github.com/baqar-abbas)
- Twitter: [@BaqarAbbas9](https://twitter.com/BaqarAbbas9)
- LinkedIn: [Baqar Abbas](https://www.linkedin.com/in/baqar-abbas/)

👤 **Dilsher Baloch**

- GitHub: [@dilsherB](https://github.com/dilsherB)
- LinkedIn: [Dilsher Balouch](https://www.linkedin.com/in/dilsher-balouch/)

👤 **K Inoulen**

- GitHub: [@lenkon](https://github.com/lenkon)
- LinkedIn: [K Inoulen Shanongba](https://www.linkedin.com/in/inoulen-konjengbam/)

(back to top)

## 🔮 Future Features

- [ ] **[Add more projects]**
- [ ] **[Add milestones and achievements]**

remove a selected book add genre to selected

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../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 **![Microverse](https://img.shields.io/badge/Microverse-blueviolet)** and my partners for their participation in this project.

(back to top)

## 📝 License

This project is [MIT](https://github.com/baqar-abbas/rubyCapstone-catalog-of-things/blob/main/LICENSE.md) licensed.

(back to top)