Diegogagan2587/catalog-of-my-things

README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Catalog of my things

Lear more about the project below:

Catalog of my things is a a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. As well this app is able to preserve the data, data will be saved in the data that will contain a JSON file per each item. As well We have included a table representation in SQL.

Click here to see our video presentation.

🛠 Built With

Tech Stack

Learn more below:

Programming Language

• Ruby

Preserving Data

• JSON

Test

• Rspec

Database

• PostgreSQL

Key Features

Some relevant key features below:

• Add Items like books, games and music albums
• Display each kind of item within a list
• Preserve de Data in JSON files

(back to top)

🚀 Live Demo

Not availabe yet.

(back to top)

💻 Getting Started

Would you like to make use of this project?

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

Prerequisites

In order to run this project you need:

• Ruby pre-installed
• Basic knowledge about how to use the terminal
• Code editor (We do recommend Vscode)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Diegogagan2587/catalog-of-my-things.git

Install

Install this project with:

  cd catalog-of-my-things
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec test/

(back to top)

👥 Authors

👤 Ricardo Martínez

• GitHub: @bohaz
• Twitter: @Ricardo29115571
• LinkedIn: Ricardo Martinez

👤 Diego Vidal

• GitHub: @Diegogagan2587
• Twitter: @dieg02587
• LinkedIn: diego-vidal-lopez

👤 khaled alaa

• GitHub: Khaled-Alaa-1
• Twitter: @Khaled86756991
• LinkedIn: Khaled Alaa

(back to top)

🔭 Future Features

• User Authentication
• Advanced Searching and Sorting
• Interactive UI/UX
• API Integration

(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 let us know with a STAR⭐!

(back to top)

🙏 Acknowledgments

We would like to thaks Microverse for giving us the oportunity to build and contribute in projects like this.

(back to top)

📝 License

This project is MIT licensed.

(back to top)