Outkarm / ruby-capstone-project

Catalog of my things 📚💿🎮

📗 Table of Contents

• Catalog Ruby
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Usage
    • Run tests
  • ✍️ Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

Catalog Ruby

Is a command line interface app built with Ruby that will help users to keep a record of different types of things, like books, music albums, and games.

🛠 Built With

- Tech Stack

Client

• Ruby

Testing

• RSpec

Linter

• Rubocop

Key Features

• Create items like book, music album and game
• List added items
• Preserve each item's data in a separate JSON file

(back to top)

👉 Zoom video link

💻 Getting Started

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

Prerequisites

In order to run this project you need Ruby installed on your machine.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Outkarm/ruby-capstone-project.git

Installation

Install this project with:

  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  cd spec
  rspec classname_spec.rb

(back to top)

✍️ Authors

👤 Aman Worku:

• GitHub: @Aman_on_GitHub
• Twitter: @Aman_on_Twitter
• LinkedIn: @Aman_on_LinkedIn

👤 John (Koy OutKarm) Kpordje

• GitHub: @Outkarm
• Twitter: @outkarm
• LinkedIn: John (Koy OutKarm) Kpordje

👤 Amaka Laura Konwea:

• GitHub: @lawrahkonwea
• Twitter: @lawrah_xo
• LinkedIn: @laura--LinkedIn

(back to top)

🔭 Future Features

• Remove selected book
• Add genre selected book

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [https://github.com/AmanWorku/Catalog-Ruby/issues).

(back to top)

💖 Show your support

If you like this project, please consider giving it a 🌟.

(back to top)

🙏 Acknowledgments

We would like to thank microverse for serving this opprtunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)