📗 Table of Contents

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

📖 [Catalogue_Of_My_Things]

[Catalogue_Of_My_Things] is a console app that will help to keep a record of different types of things one owns: books, music albums, movies, and games. Everything is based on the UML class diagram. The data is stored in JSON files but we also prepare a database with tables structure analogical the program's class structure.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• [User Interface]
• [Add Database to store the whole data]
• [preserve data in json format]

(back to top)

🚀 Video Link

• Video Link

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

  install  sudo apt-get install ruby-full

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone  https://github.com/brhanuhailu/ruby-capstone.git

Install

Install this project with:

  cd project
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run Linter tests, run the following command:

  rubocop

Run unit tests

To run unit tests, run the following command:

  Rspec

Deployment

Not applicable.

(back to top)

👥 Authors

👤 Daniel Matama

• GitHub: @Recillah-Khamala
• Twitter: @recillahk
• LinkedIn: Recillah Khamala

👤 Brhanu Hailu

• GitHub: @brhanuhailu
• Twitter: @tigrayfurtune
• LinkedIn: LinkedIn

👤 Yodit Abebe

• GitHub: @yodit93
• Twitter: @@yodtwit
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Add more unit tests]
• [Create complete databases]

(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 give a ⭐️ and We are so excited to accept you feedback to improve our profession.

(back to top)

🙏 Acknowledgments

we would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.