ifeanyi305/Catalog-of-Things

Catalog of things

📗 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
• 📝 License

📖 [Catalog of things]

[Catalog of things] Is 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 was based on the UML class diagram presented. The use data will be preserved in a json file.

🛠 Built With Ruby

Tech Stack

Client

• Ruby

Database

• PostgreSQL
• JSON

Key Features

• [keep a record of different types of things you own: books, music albums, movies, and games.]
• [List all your data when the option is selected]
• [Store user data to the storage]

(back to top)

🚀 Project Video

• Live Demo 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:

 You need to have ruby installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Trust-007/Catalog-of-Things.git

Install

Install this project with:

  cd catalog_of_my_things
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Simeon Trust

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

👤 Ifeanyi Oti

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

👤 Kennedy Omondi

• GitHub: @kennankole
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [ remove a selected book ]

(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 please give it a star

(back to top)

🙏 Acknowledgments

I would like to thank Microverse

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