ohyajk / ruby-capstone

📗 Table of Contents

• 📗 Table of Contents
• 📖 Catalog of my things
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Catalog of my things

This project is a simple Ruby app that allows you to add books, musics and games to a catalog. It also allows you to list all books, music and games. All data is preserved in a json file. The project also includes a schema file with tables of the classes in the app.

🛠 Built With

Tech Stack

Server

• Ruby

Key Features

• Add books, musics and games
• List all books, music and games
• All data preserved in json file
• Schema file with tables of the classes in the app

(back to top)

🚀 Live Demo

• Not Available
• Video Explaination

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

• Mac or PC
• Install Ruby
• Understanding OOP principles

Setup

Clone this repository to your desired folder:

  cd your-folder
  https://github.com/ohyajk/ruby-capstone.git

Install

Install this project with:

• GitHub Actions
• Linters
  • Rubocop
• Ruby

Usage

• Run the app with ruby main.rb in the terminal from the root folder of the project.

(back to top)

👥 Authors

👤 Jitender Kumar

• GitHub: @ohyajk
• LinkedIn: @ohyajk

👤 Houda Mzari

• GitHub: @houdamzari
• LinkedIn: @houda-mzari-2304401b1

👤 Teklay Birhane

• GitHub: @Tekhlay
• LinkedIn: @teklay-birhane-20b64a18a

(back to top)

🔭 Future Features

• remove a selected book
• add genre to 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 leave a ⭐️

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for providing the reading materials that aided me during the project development

(back to top)

❓ FAQ

• Can I use this code?

  • yes, it is open source. Feel free to fork it.

• Can I contribute to this project?

  • Contact me so I can add you as a collaborator. Alternatively you can leave an issue, it will be well appreciated.

(back to top)

📝 License

This project is MIT licensed.

(back to top)