Ruby_Catalog_my_things_capstone

Ruby_Catalog_my_things_capstone

"Catalog of my things" is a simple console app that allows users to manage collections of the things they own. It's based on the following UML class diagram.

video

📗 Table of Contents

• Ruby_Catalog_my_things_capstone
• 📗 Table of Contents
• 📖 Ruby_Catalog_my_things_capstone<
  • 🛠 Built With Ruby
    • Tech Stack
    • Key Features
    • Future Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Ruby_Catalog_my_things_capstone

Ruby_Catalog_my_things_capstone "Catalog of my things" is a simple console app that allows users to manage collections of the things they own.

🛠 Built With Ruby

Tech Stack

• RubyGems
• rubocop
• linters for Ruby

Key Features

• Add the logic for all ruby classes and their methods according to the UML graph
• Add simple terminal user interface for user interaction
• Save records to json files
• Load records from json files
• Add the layout schema files to be used in the future to link the app with sql database
• Rspec test Units for all methods used on each class
• Used linter workflow for more organized code

(back to top)

🔭 Future Features

• Link the project to a sql database
• Make a graphical user interface

(back to top)

(back to top)

💻 Getting Started

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

• Open your Terminal in your VSCode.
• Navigate to the desired directory[folder] to which you want to clone the repository to
• git clone you find in the code button https://github.com/faisalakb/Ruby_Catalog_my_things_capstone.git
• Run blunder i to install the gemfiles to your end
• To run the app ruby main.rb you will see the user interface

Prerequisites

To run and modify this project you need:

• GitHub account
• VSCode (or another code editor)
• gemfile installed
• basic Knowledge of Git Commands
• basic Knowledge of the Terminal Commands
• Ruby language
• PostgreSQL

Setup

Clone this repository to your desired folder:

• git clone https://github.com/faisalakb/Ruby_Catalog_my_things_capstone.git

Example commands:

  cd my-folder
  git clone https://github.com/faisalakb/Ruby_Catalog_my_things_capstone.git

Install

To install all dependencies run the following command:

• gem install will install all the gem files included in this repo
• if you have the gem bundler installed type in bundler i
• to run the program ruby main.rb

suggusted VSC extentions:

• Prettier Extention in VScode
• Microsoft Edge Tools for VS Code
• Save Typing
• code spell checker
• ruby solargraph

(back to top)

👥 Authors

Faisal Mumtaz

• GitHub: @faisalakb
• Twitter: @faisalakb786
• LinkedIn: LinkedIn

👤 GeekyHacks

• GitHub: Geekyhacks
• Twitter: Geekydart
• LinkedIn: Abdullah Nasser

(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 don't hesitate to support me with your valued contribution and don't forget to star the repo to reach more people.

(back to top)

🙏 Acknowledgments

I would like to thank...

• Microverse Review Team
• Microverse Community in Slack
• My coding partner @geekyhacks

(back to top)

❓ FAQ

Can I clone this project ?**

• Of course you can as long as you fork it and star it Can I contribute to this project?**
• all contributions are welcomed

(back to top)

📝 License

This project is MIT licensed.

(back to top)