Catalog Of My Things

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • 🚀 Video Link
• 💻 Getting Started
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Catalog of my Things

Catalog of my Things Is our Capstone Project for Microverse Module 4: Ruby. In this app you can store your desired Items (music albums, games, or books) with their respective author, genre and label. You can also see a full list of each class and delete items!

🛠 Built With

Tech Stack

Ruby

• Ruby

Rspec

• Rspec

🚀 Video Demo

Video Presentation

(back to top)

💻 Getting Started

Catalog of my things is console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files. Created using Ruby!

Setup

1. Ensure you have Ruby installed on your system. You can check your Ruby version in the terminal by running:

ruby -v

If Ruby is not installed, you can download and install it from the official Ruby website.

2. To get a local copy up and running, follow these steps. Choose the directory on your local machine where you want to copy project. For example:

cd /home/user/name-of-your-directory

Clone the project using one of the options.

Using SSH-key:

git clone git@github.com:mrcbq/catalog-of-my-things.git

Using HTTPS:

git clone https://github.com/lerfast/m4capstone-catalog-of-my-things-.git

You can also create the new directory just adding the name of it in the end of command. For example:

git clone https://github.com/lerfast/m4capstone-catalog-of-my-things-.git catalog

Installation

To run this project locally, follow these steps:

1. Open your terminal or command prompt.

2. Navigate to the directory where you have cloned or downloaded the Catalog of My Things repository.

3. Run the following command to install any required dependencies (in this case, we assume there are no external dependencies, so this step may not be needed):

bundle install

Usage

1. Once the setup is complete, ensure you are still in the directory containing the Catalog of My Things files.

2. To run the app, execute the following command:

ruby main.rb

3.If you have future features like GUI or interactive mode, follow the specific instructions provided for those features in the app's documentation.

Tests

To run the tests ensure you are in the directory containing the test files.

1. Install RSpec:

Once you have Ruby installed, you can use RubyGems (Ruby's package manager) to install RSpec. Open your terminal or command prompt and run the following command:

gem install rspec

2. Run the tests using the following command:

rspec

3. All tests should pass without any errors or failures, ensuring that the code and its methods are functioning correctly.

(back to top)

👥 Authors

👤 Tomas Esquivel

• GitHub: @tomasesquivelgc
• Twitter: @EsquivelTomas
• LinkedIn: Tomas Esquivel

👤 Luis Emilio Rojas Rojas

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Javier Jesús Martinez Fariñas

• GitHub: @jlcarrascof
• Twitter: @javiersistemas

(back to top)

🔭 Future Features

-[ ] Movie Data -[X] Erase Items -[ ] Item Source

(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 give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving us the opportunity to learn and grow as developers and also I like to thank my family, they are all my support. 🌟

(back to top)

📝 License

This project is MIT licensed.

(back to top)