tamoorsaeed22/catalog-of-my-things

"Catalog of My Things" is an innovative and collaborative console application designed to revolutionize the way users manage and organize their collections of various items, including Books, Music Albums, Movies, and Games. This groundbreaking project is the result of a passionate collaboration between a diverse team of programmers.

catalog-of-my-things

📗 Table of Contents

• 📗 Table of Contents
• 📖 [catalog-of-my-things ]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🔭 Video Presentation
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 [catalog-of-my-things]

This project is made as part of the Microverse curriculum for module 4- Ruby and Databases. "Catalog of my things" is a simple console app that allows users to manage collections of the things: Books, Music Albums, Movies, and Games.

🛠 Built With

Ruby

Tech Stack

Server

• Ruby

PostgreSQL

• PostgreSQL

Key Features

• TDD concept.
• Unit tests using Rspec.
• Implement classes and objects in Ruby.

(back to top)

🔭 Video Presentation

• Video Presentation

(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:

• Ruby installed and running.
• You should be able to use IRB.

Setup

Clone this repository to your desired folder:

  cd catalog-of-my-things
  git git@github.com:tamoorsaeed22/catalog-of-my-things.git 

Install

Install this project with:

  cd catalog-of-my-things
  gem install

Usage

To run the project, execute the following command:

  gem install bundler

Then run:

bundle install

run ruby app in the command line:

ruby main.rb

Run tests

To run tests, run the following command:

- Run rspec spec spec/filename.rb

Deployment

You can deploy this project using:

(back to top)

👥 Author

👤 Marco diaz

• GitHub: @MarcoDiaz
• Twitter: @MarcoDiaz
• LinkedIn: LinkedIn

👤 Tamoor Saeed

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Abdul Ali Noori

• GitHub: @ab-noori
• Twitter: @AbdulAliNoori4
• LinkedIn: abdulali-noori

(back to top)

🔭 Future Features

• Localization and Internationalization
• Continuous Integration and Deployment
• Error Handling and Exception Handling

(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 so please don't forget to give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank all code reviewers for making this project better.

(back to top)

📝 License

This project is MIT licensed.

(back to top)