📗 Table of Contents

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

📖 Catalog Of My Things

In this project, you will create a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but you will also prepare a database with tables structure analogical to your program's class structure. "Catalog of my things" should be a simple console app that allows users to manage collections of the things they own.

🛠 Built With

Tech Stack

This Project was Build with the following:

Client

• Ruby
• SQL
• Rspec

Code Editor

• VSCode

Database

• PostgreSQL

Key Features

The Following are key features of the Catalogue of my things application

• User Has the ability to archive any catalogue.
• Present the user with a list of options to perform.
• If needed, ask for parameters for the option.

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

The following steps were used in creating this project:

1. Setup the project by creating a new directory from the generated repository.
2. Set up the repository on GitHub and use Gitflow.
3. Initialized project with rubocop linters

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

Prerequisites

In order to run this project you need:

1. Ruby installed
2. Rspec Installed

Setup

Clone this repository to your desired folder:
git clone shh key

Install

Install this project with:
cd Ruby-Capstone-Project-Catalouge-Of-My-Things
gem install rspec

Usage

To run the project, execute the following command: ruby main.rb

Run tests

To run tests, run the following command: rpec spec

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 PRATAP PANABAKA

• GitHub: @PRATAP-KUMAR
• Twitter: @PRATAP_TWT
• LinkedIn: LinkedIn

👤 Alusine Jalloh

• GitHub: @Alusp
• LinkedIn: @alusine-jalloh
• Twitter: @aseni_jalloh

👤 David Kasilia Mwanzia

• GitHub: @David-Kasilia
• Twitter: @DavidKasilia
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Add A Movie Catalogue
• Add a movie label
• Add movie writter

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• How Long did it take to build this project?

  • One week

• How many git conflicts did you resolve?

  • Around thrice while merging.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)