Olivier-Kango/catalog_of_my_things

A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. 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.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 Catalog of my things

A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. 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.

Please click on the video below 👇 for more explanation

Explanation video

🛠 Built With

Tech Stack

• Ruby
• Postgres

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• IDE or code editor: VsCode, atom, sublime...
• To have Ruby and Git installed on your system.

Setup

Clone this project on your local machine using the following command on your terminal:

  git clone https://github.com/Olivier-Kango/catalog-of-my-things.git

Install

Run the following command to install all project's dependencies:

bundle install

Run the following command to install Rspec for tests:

gem install rspec

Usage

To run the project, execute the following command:

  ruby main.rb

Run Tests

Run the following command to catch all style errors:

rubocop

Run the following command for the rspec tests(with details):

rspec ./spec --format documentation

👥 Authors

👤 Kareem Magdy Wilson

• GitHub: @KareemWilson
• LinkedIn: LinkedIn

👤 Olivier Kango

• GitHub: @githubolivier
• Twitter: @twitterolivier
• LinkedIn: LinkedIn

👤 Dave Zagabe

• GitHub: @daveZag
• Twitter: @davezagabe2
• LinkedIn: @davezagabe

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give this project a star if you like it !

📝 License

This project is MIT licensed.

(back to top)