uchexm / catalog_my_things_ruby

This project is console app built using ruby, the app will help you to keep a records of different types of things you own: books, music albums, movies, and games, the data are stored in json file, and it will be always useable whenever you start the app.

📗 Table of Contents

• 📖 About the Project -📹 Video Presentation

  • 📷 screenshot
  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Usage

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📇 Catalog of my things

This project is console app built using ruby. It keeps a records of different things:

• books
• music
• albums
• movies
• games

Data are stored in json file and could be used whenever you start the app.

📹 Video Presentation

📷 Screenshot

🛠 Built With

Tech Stack

• Languages: Ruby
• Postgresql
• Frameworks: N/A
• Technologies Used: GIT, GITHUB, LINTERS

Key Features

• Keep track of all things own by a user
• Created using ruby to keep a records of different types of things a user own: books, music albums, movies, and games

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

• Command line or terminal
• IDE such as VsCode.
• Ruby needs to be installed on your system.

Setup

Clone this repository to your desired folder: Example command:

  git clone https://github.com/jugosack/catalog_my_things_Ruby
  cd catalog_my_things

Install

Example command:

  cd catalog_my_things_Ruby
  bundle install (install all dependencies)

Usage

To run the project redirecting to the root directory of the project and run the following command:

 ruby main.rb (to run console application)

Test

To test the web app run the following command:

 rspec spec (to test the console application)

👥 Authors

👤 Jugoslav Achkoski

• GitHub: @github
• LinkedIn: LinkedIn
• Twitter: twitter
• Facebook: facebook

👤 Uchechi Nwaka

• -- GitHub: @uchexm
• -- LinkedIn: @nwakauc
• -- Twiter @nwakauc

👤 Damilare Arikeusola

• GitHub: @mrprotocoll
• Twitter: @dprotocoll
• LinkedIn: @mrprotocoll

(back to top)

🔭 Future Features

• Add web interface
• Improve unit tests

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

we would like to thank microverse community for the support and guidance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)