Ruby Group Capstone: Catalog of My Things

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 🎥 Video Demonstration
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Catalog of My Things

Catalog of My Things is a console app that will help a user to keep a record of different types of things he owns: books, music albums, and games. Everything will be based on the UML class diagram presented above. The data will be stored in JSON files but we will also prepare a database with tables structure analogical to our program's class structure.

🛠 Built With

Tech Stack

Client

• Ruby
• Rspec

Database

• PostgreSQL

Key Features

• 1 - User interface where the user can choose between a variety of options

  

• 2 - All the data is preserved in json files

• 3 - Create as part of a collaborative project

• 4 - All data is stored in a database

(back to top)

🎥 Video Demonstration

You can see the Video demonstration 📍 here.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

 gem install bundler

Setup

Clone this repository to your desired folder:

  cd my-folder
  git https://github.com/rivasbolinga/my-things.git

Install

Install this project with:

  cd my-things
  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

(back to top)

👥 Authors

👤 Andrea Rivas

• GitHub: @rivasbolinga
• Twitter: @AndreaRivasPal
• LinkedIn: andrearivaspalacios

👤 Christian Romuald Momo Tonfack

• GitHub: @momo-87
• Twitter: @Momo-yde
• LinkedIn: christian-momo

👤 Mohamad Almeari

• GitHub: @mohametalmeari
• Twitter: @MohametAlmeari
• LinkedIn: mohamet-almeari

(back to top)

🔭 Future Features

• Add Movie class
• Remove and update options
• Create more relationships between the classes

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse community for their supports.

(back to top)

📝 License

This project is MIT licensed.

(back to top)