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.

Catalogue of My Things

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 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 to view the presentation of the project.

(back to top)

💻 Getting Started

To clone the repository in local environment try following steps.

Prerequisites

• 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.

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
• LinkedIn: Prangon Ghose

👤 Shinhyo Belliard

• GitHub: @ShinhyoBelok
• Twitter: @Bell_iraki
• LinkedIn: LinkedIn

👤 Alejandra Keber Maggi

• GitHub: @AlejandraKeber
• Twitter: @KeberAlejandra
• LinkedIn: 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.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Authors would like to thank:

• Microverse
• Code Reviewers
• Coding Partners

(back to top)

📝 License

This project is MIT licensed.