📗 Table of Contents

• 📗 Table of Contents
• 📖 [Catalog-of-things]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 [Catalog-of-things]

A ruby-based console application to help you to keep a record of different types of things you own: books, music albums, movies, and games. You can find more details about the app here

🛠 Built With

Tech Stack

Client

• RUBY

Server

• N/A

Database

• N/A

Key Features

• List all books
• List all music albums
• List all games
• List all genres
• List all labels
• List all authors
• Add a book
• Add a music album
• Add a game

(back to top)

💻 Getting Started

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

• clone this repo:https://github.com/Stephen-Adom/catalog-of-things.git

Prerequisites

In order to run this project you need ruby installed:

On Linux:

 sudo apt-get install ruby-full

On Windows

Go to Windows Subsystem for Linux to set up wsl for Ubuntu

Setup

Clone this repository to your desired folder:

  git clone git@github.com/Stephen-Adom/catalog-of-things
  cd catalog-of-things

Install

This project does not require installation.

Usage

To run the project follow the following instructions:-

• Clone this catalog-of-things in your local machine with correct branch.
• Run ruby main.rb

Run tests

To run tests, run the following command: rspec spec/*.

Deployment

You can deploy this project using: Not available

(back to top)

👥 Authors

👤 Stephen Addae

• GitHub: @Stephen-Adom
• Twitter: @stephen_alaska
• LinkedIn: Stephen Addae

👤 AmenMusingarimi

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Williams Serubiri

• GitHub: @veronica365
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Preserve records in database]
• [Add authentication]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [repo:https://github.com/Stephen-Adom/catalog-of-things.git]

(back to top)

⭐️ Show your support

If you like this project please follow me on github

(back to top)

🙏 Acknowledgments

We would like to thank Microverse and my colleagues.

(back to top)

❓ FAQ (OPTIONAL)

• [What is Catalog of things Project?]

  • [It's an application to help you to keep a record of different types of things you own: books, music albums, movies, and games.]

(back to top)

📝 License

This project is MIT licensed.

(back to top)