Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maximoortelli/ruby-capstone-group


https://github.com/maximoortelli/ruby-capstone-group

Last synced: 20 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Catalog_Of_My_Things (Ruby Console App)



## 📗 Table of Contents



- [Catalog\_Of\_My\_Things (Ruby Console App)](#catalog_of_my_things-ruby-console-app)

  - [📗 Table of Contents](#-table-of-contents)

  - [📖 Catalog\_Of\_My\_Things ](#-catalog_of_my_things-)

  - [🛠 Tech-stack ](#-tech-stack-)

  - [🛠 Built With ](#-built-with-)

  - [Key Features ](#key-features-)

  - [Future Features ](#future-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Setup ](#setup-)

    - [Prerequisites ](#prerequisites-)

  - [Usage ](#usage-)

  - [👥 Authors ](#-authors-)

  - [❓ FAQ ](#-faq-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show Your Support ](#️-show-your-support-)

  - [📜 License ](#-license-)



## 📖 Catalog_Of_My_Things 



Welcome to the Catalog of My Things console app! This Ruby-based application allows you to manage collections of items you own, including books, music albums, movies, and games. You can keep track of various details about these items and perform tasks such as adding new items, listing items, and more.



## 🛠 Tech-stack 



This project is implemented using the Ruby programming language, known for its elegant syntax and flexibility. Ruby provides a suitable foundation for this Catalog of My Things code decoding project due to its ease of use and string manipulation capabilities.



## 🛠 Built With 



This project is built using Ruby, a dynamic, open-source programming language known for its simplicity and productivity. Ruby's elegant syntax and powerful features make it a popular choice among developers.



## Key Features 

- [x] Implementation of functions using `def ...end` syntax.

- [x] Display output using `puts ...`.

- [x] Create classes using `class ...end` syntax.

- [x] Preserve the data in `json` format.

- [x] Retrieve data from the existing file and save to the their relavent arrays



## Future Features 

- User Authentication: Implement a user authentication system to allow multiple users to have their own catalogs and keep their data separate.

- Search Functionality: Add a search feature that allows users to search for specific items in their catalog based on criteria such as title, author, or genre.

- Data Export/Import: Provide the ability to export and import catalog data to and from CSV or other common formats for backup and sharing purposes.

- Item Reviews: Allow users to leave reviews and ratings for items in their catalog, creating a personal rating system.



## 💻 Getting Started 



To get started with the Catalog of My Things app, follow the instructions below:



### Setup 



1. Clone the project repository:

   bash

   git clone https://github.com/maximoortelli/Ruby-Capstone-Group.git

   



2. Navigate to the project folder:

   bash

   cd Ruby-Capstone-Group

   



### Prerequisites 



To run the Catalog of My Things app, you'll need the following prerequisites:



- An integrated development environment (IDE) like Visual Studio Code.

- Ruby installed on your machine.

- Git installed on your machine.

- A GitHub account for version control.



## Usage 



Follow these steps to use the program:



1. Open your terminal.

2. Navigate to the directory where the program files are located using the `cd` command:



   bash

   cd /path/to/your/program/files

   



3. Start the Interactive Ruby (IRB) console by typing `irb` and pressing Enter:



   bash

   irb

   



4. Inside the IRB console, load the `main.rb` file to execute the program:



   ruby

   load 'main.rb'

   



5. The program will run, and you will see the main menu in the console, prompting you to choose an option.



6. Select an option by entering the corresponding number and follow any prompts for additional input.



7. Interact with the program as needed to perform tasks such as listing items, adding items, and more.



That's it! You've successfully executed the program and can manage your catalog of items.



## 👥 Authors 



This project was developed by:



👤 **Maximo Ortelli**

-   GitHub: [@Maximo Ortelli](https://github.com/maximoortelli)

-   LinkedIn: [@Maximo Ortelli](https://www.linkedin.com/in/maximo-ortelli-rueda/)



👤 **Fisayo Michael Animashaun**

- GitHub: [@Fisayo Michael Animashaun](https://github.com/fmanimashaun)

- LinkedIn: [@Fisayo Michael Animashaun](https://www.linkedin.com/in/fmanimashaun/)



## ❓ FAQ 



*Q: Is there a plan to add more features to this application?*

A: Yes, the development team has plans to enhance this application's capabilities. One upcoming feature is to make the application executable via tactil, providing more convenience and accessibility to users.

 



*Q: Where can I find more information about the Ruby programming language?*

A: For more information about Ruby, its features, and its community, visit the official [Ruby website](https://www.ruby-lang.org/).



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/maximoortelli/Ruby-Capstone-Group/issues) and contribute to the project.



## ⭐️ Show Your Support 



If you find this project helpful, consider giving it a ⭐️ to show your support!



## 📝 License 



This project is [MIT](./LICENSE).



(back to top)