README.md

📗 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

📖 [CATALOG OF MY THINGS]

[CATALOG OF MY THINGS] "Catalog of my things" is a simple console app that allows users to manage collections of the things they own.

🛠 Built With Ruby

• ruby

Tech Stack Ruby

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
• A means to Quit the application

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

• Text Editor (VScode, Atom, Sublime text, etc)
• Basic knowledge of ruby

In order to run this project you need:

• install ruby
• Signup to Github

Setup

Clone this repository to your desired folder:

Command:

• git clone git@github.com:Kasaija-Kenneth/ruby-capstone-gproject.git
• cd ruby-capstone-gproject

Install

• After opening the files in Visual Studio Code, open the VS Code integrated terminal and run the following commands:

bundle init bundle install

Usage

• Run the command in your terminal below to run the ruby program

ruby main.rd to run

Run tests

• run rspec command to do spec_tests
• Run the rubocop -A command in your terminal for linter checks and corrections

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Kasaija Kenneth

• GitHub: @Kasaija-Kenneth
• LinkedIn: LinkedIn
• Twitter: @kenn_ug
• Email: Send me a message:

👤 Harrison Njuguna

• GitHub: @Harrynoqs
• Twitter: @Harrynoqs
• LinkedIn: harrisonw-njuguna

👤 Masouma Modarresi

• GitHub: @masouma
• LinkedIn: @masouma

(back to top)

🔭 Future Features

-[ ] [ To be communicated ]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

(back to top)

📝 License

This project is GPL licensed.

(back to top)