federicaulzurrun/Catalogue-of-my-things

📗 Table of Contents

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

📖 Catalogue of my things

Catalogue of my Things is a ruby object-oriented programming console app that will help you record different types of things you own: books, music albums, movies, and games.

🛠 Built With

Tech Stack

Backend

• Ruby

Key Features

• Implemented classes and objects in Ruby
• Implemented inheritance, abstraction, encapsulation and polymorphism
• Implemented database using postgresql

(back to top)

🎥 Video Presentation

Click here to watch a short video presentation about the project.

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need to Install Ruby

Setup

Clone this repository to your desired folder:

  cd <my-folder>
  git clone git@github.com:sameedmohsin28/Catalogue-of-my-things.git

Run

Run this project with:

  ruby classes/main.rb

Run tests

Run bundle install in cmd

  bundle install

Run rspec in cmd

  rspec

👥 Authors

👤 Sameed Mohsin

• GitHub: @sameedmohsin28
• Twitter: @sameedmohsin22
• LinkedIn: Sameed Mohsin

👤 Eric Antwi

• GitHub: Eric Antwi
• Twitter: Eric Antwi
• LinkedIn: Eric Antwi

👤 Federica Ulzurrun

• GitHub: @federicaulzurrun
• Twitter: @ulzurrunfede
• LinkedIn: Federica Ulzurrun

(back to top)

🔭 Future Features

• The frontend will be developed later
• A mobile version for this project will be created

(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 kindly give us a star or a thumbs up.

(back to top)

🙏 Acknowledgments

We would like to thank the entire Microverse staff and colleagues for making this bootcamp interesting.

(back to top)

📝 License

This project is MIT licensed.

(back to top)