Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lucas-erkana/catalog-ruby-group-capstone

A console Ruby application built with a team of three. It allows users to store musics, books, and games and the data is been preserved in a JSON file and is been retrived and populated back to the user when the user needs it by selecting the right option from the list of options provided.
https://github.com/lucas-erkana/catalog-ruby-group-capstone

collaboration json pair-programming rspec-testing ruby teamwork

Last synced: 19 days ago
JSON representation

A console Ruby application built with a team of three. It allows users to store musics, books, and games and the data is been preserved in a JSON file and is been retrived and populated back to the user when the user needs it by selecting the right option from the list of options provided.

Awesome Lists containing this project

README

        

Catalog-Ruby-Group-Capstone

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Video Presentation ](#video-project-presentation)
- [💻 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)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Catalog-Ruby-Group-Capstone

- Ruby app for storing favourite Books, Music Albums or Games.

- You can also add a new book, music album or game.

## 🛠 Built With

- Ruby

### Tech Stack

Client


  • Ruby

Test


  • RSPEC

Database


  • PostgreSQL

### Key Features

- **Add Book** - Add your favourite book.
- **Add a Music Album** - Add your favourite music album.
- **Add a Game** - Add your favourite game.

(back to top)

## 🚀 Video Project Presentation

- Video Project Presentation 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: any web-browser.

### Setup

Clone this [repository](https://github.com/Lucash2022/Catalog-Ruby-Group-Capstone) to your desired folder.

### Install

This project does not require installation.

### Usage

**To run the project follow the following instruction:-**

- Clone this [repository](https://github.com/Lucash2022/Catalog-Ruby-Group-Capstone) in your local machine with correct branch.
- Run **ruby main.rb**

### Run tests

To run tests, run the following command: **rspec**.

(back to top)

## 👥 Authors

👤 **Lucas Erkana**

- GitHub: [@Lucash2022](https://github.com/Lucash2022)
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)

👤 **Kagheni Mbale Christian**

- GitHub: [@githubhandle](https://github.com/Kaghenimbale)
- Twitter: [@twitterhandle](https://twitter.com/MbaleKagheni)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kagheni-mbale-401b90240/)

👤 **Ghulam Hyder Dar**

- GitHub: [@codeWithHyder](https://github.com/codeWithHyder)
- Twitter: [@Hyder](https://twitter.com/@hyder3512)
- LinkedIn: [@Hyder](https://www.linkedin.com/in/ghulam-hyder-dar/)

(back to top)

## 🔭 Future Features

- [ ] **add genre to selected book**
- [ ] **add movies**
- [ ] **add genre to selected movie**
- [ ] **Remove movies**
- [ ] **Remove a selected book**
- [ ] **Remove a selected music album**
- [ ] **Remove a selected game**

remove a selected book
add genre to selected book

(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 a ⭐️.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

## ❓ FAQ (OPTIONAL)

- **Can I use this project?**

- It's MIT license, feel free to use as you like.

(back to top)

## 📝 License

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

(back to top)