https://github.com/prangonghose/catalogue-using-ruby

A terminal UI to add books, games and music albums according to user. Built with Ruby. All user data is saved in the local storage and loaded immediately at the beginning of the app.
https://github.com/prangonghose/catalogue-using-ruby

oop rspec ruby ruby-gem

Last synced: about 4 hours ago
JSON representation

A terminal UI to add books, games and music albums according to user. Built with Ruby. All user data is saved in the local storage and loaded immediately at the beginning of the app.

• Host: GitHub
• URL: https://github.com/prangonghose/catalogue-using-ruby
• Owner: PrangonGhose
• License: mit
• Created: 2023-03-20T19:06:45.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-03-24T20:55:24.000Z (almost 2 years ago)
• Last Synced: 2024-12-08T20:49:16.072Z (about 2 months ago)
• Topics: oop, rspec, ruby, ruby-gem
• Language: Ruby
• Homepage:
• Size: 2.71 MB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

  
Catalogue of My Things




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [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)

# 📖 Project Name

## Catalogue of My Things

## 🛠 Built With 

- `Ruby`

### Key Features 

> Describe between 1-3 key features of the application.

- A terminal UI to add books, games and music albums according to user.

- Built with Ruby.

- All user data is saved in the local storage and loaded immidiately at the beginning of the app.

(back to top)


## 🚀 Live Demo 

Click [here](https://drive.google.com/file/d/1qMN3X6amC4gjJSWvXy1oDyuf-1pqK_Rs/view?usp=share_link) to view the presentation of the project.

(back to top)


## 💻 Getting Started

To clone the repository in local environment try following steps.

### Prerequisites

- [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

```

$ git --version

```

Likewise for Node.js and npm for package installation.

```

$ ruby --version && gem --version

```

### Setup

Clone the repository using [this link](https://github.com/PrangonGhose/catalogue-using-ruby.git).

### Install

In the terminal, go to your file directory and run this command.

```

$ git clone https://github.com/PrangonGhose/catalogue-using-ruby.git

```

### Get into development

In the terminal, run these commands to get into development.

```

$ cd catalogue-using-ruby

$ bundle init

$ bundle install (install dependencies)

$ ruby main.rb (run the app locally)

```

### Usage

This website is applicable for both mobile and desktop version.

### Deployment

(back to top)


## 👥 Authors 

👤 **Prangon Ghose**

- GitHub: [@PrangonGhose](https://github.com/PrangonGhose)

- LinkedIn: [Prangon Ghose](https://www.linkedin.com/in/prangon-ghose/)

👤 **Shinhyo Belliard**

- GitHub: [@ShinhyoBelok](https://github.com/ShinhyoBelok)

- Twitter: [@Bell_iraki](https://twitter.com/Bell_iraki)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/shinhyo-belliard-okazaki-807a38249/)

👤 **Alejandra Keber Maggi**

- GitHub: [@AlejandraKeber](https://github.com/AlejandraKeber)

- Twitter: [@KeberAlejandra](https://twitter.com/KeberAlejandra)

- LinkedIn: [alejandra-keber](www.linkedin.com/in/alejandra-keber)

(back to top)


## 🔭 Future Features 

- [ ] **Removing selected items (book, game, albums)**

- [ ] **Add genre, label and author to selected items**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the [issues page](https://github.com/PrangonGhose/catalogue-using-ruby/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

Authors would like to thank:

- [Microverse](https://www.microverse.org/)

- Code Reviewers

- Coding Partners

(back to top)


## 📝 License 

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