christianonoh / ruby-capstone

Collectify: Your Personal Catalog

UML Diagram

📗 Table of Contents

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

📚🎵🎮 Collectify

Collectify is a console app that allows you to manage and organize your personal collections of books, music albums, movies, and games. It provides a simple and intuitive interface for adding items, listing them by category, and performing various operations. The data is stored in JSON files, ensuring that your collections are preserved. Additionally, you have the option to store the data in a corresponding database for future scalability.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• Multiple Collections: Collectify allows you to create and manage multiple collections for different types of items, including books, music albums, movies, and games.

• Listing and Filtering: Collectify enables you to list and view all items in your collections by category, such as books, music albums, movies, or games. You can also filter items by specific genres, labels, authors, or sources to quickly find what you're looking for.

• Archiving and Preservation: The app includes a functionality to automatically archive items based on their published date or other criteria. This helps you identify and manage items that are older or no longer actively used, ensuring your catalog stays up to date.

• Data Persistence: Collectify securely stores your collections' data in JSON files, preserving your item information across app sessions. This ensures that your collections are readily available whenever you use the app.

• Database Integration: In addition to JSON file storage, Collectify provides the option to integrate with a corresponding database. This allows for scalability and flexibility in managing larger collections and provides a foundation for future enhancements.

• User-Friendly Interface: The console app features a simple and intuitive user interface, guiding you through the process of managing your collections. The menu-based navigation makes it easy to perform actions such as adding items, listing collections, and applying filters.

(back to top)

🚀 Presentation

• Click here.

(back to top)

💻 Getting Started

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

Prerequisites

Ensure you have Ruby installed on your system. You can check by running the code below in your terminal.

  ruby --version

Setup

Clone or download the Collectify repository to your local machine.

  git clone https://github.com/christianonoh/ruby-capstone.git

Open your terminal and navigate to the cloned project directory.

Install

This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.

bundle install

Usage

• To run Collectify, execute the main.rb file:

  ruby main.rb

The console app will present a menu of options for managing and interacting with your collections. Simply follow the prompts and provide the necessary information when prompted. The program will process and output your request.

(back to top)

👥 Authors

👤 Christian Onoh

• GitHub: @christianonoh
• LinkedIn: Christian Onoh

👤 Daniela Moreno

• GitHub: @daniela
• LinkedIn: Daniela Moreno

👤 Jules Edozie

• GitHub: @Jules Edozie
• LinkedIn: Jules Edozie

🔭 Future Features

• User Interface

(back to top)

🤝 Contributing

Contributions to the User Interface are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue on the project repository.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give us a star ⭐️

(back to top)

🙏 Acknowledgments

Special thanks to our team and the Ruby community for their support and contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)