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

https://github.com/diegoh40/ruby-capstone


https://github.com/diegoh40/ruby-capstone

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

logo

Microverse README Template

# πŸ“— 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)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– CAPSTONE RUBY

>This project we are building a small terminal program athat help you to manage your movies, books and music collection.

**Catalog of my things**

## πŸ›  Built With Ruby

### Tech Stack

In this project, we created a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything will be based on the UML class diagram presented below. The data stored in JSON files but we prepared a database with tables structure analogical for the program's class structure.

- Ruby

- VSCode

- Git

- GitHub

- Rubocop

- Rubocop

## πŸš€ Live Demo

> Explanation of project.

- [Video presentation.](https://drive.google.com/file/d/116W66qPCqOF5hDHFeEHye5RtY-zbJzmY/view?usp=sharing)

(back to top)

## πŸ’» Getting Started

### Prerequisites

In order to run this project you need:
`gem install`

### Setup

Clone this repository to your desired folder:
https://github.com/diegoh40/ruby-capstone.git

### Install
Install this project with:
`bundle install`

### Usage

To run the project, execute the following command:
`ruby main.rb`

### Run tests

To run tests, run the following command:
`rspec ./spec/[name of file]`

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Edith oga**
- GitHub: [@edithoga](https://github.com/vigehi)

πŸ‘€ **Diego HernΓ‘ndez**
- GitHub: [@diehoh40](https://github.com/diegoh40)
- Twitter: [@Diegoart80](https://twitter.com/Diegoart80)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/diegoarturoh/)

πŸ‘€ **Ghislain Mitahi**
- GitHub: [@GhislainMitahi](https://github.com/GhislainMitahi)
- Twitter: [@GMItahi](https://https://twitter.com/GMitahi)
- LinkedIn: [ghislainmitahi](https://linkedin.com/in/ghislain-mitahi/)

(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

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## πŸ™ Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## πŸ“ License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)