shm04/ruby-capstone

In this project, we created 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. The data is stored in JSON files but we also prepared a database with tables structure analogical to your program's class structure.

Ruby group capstone - Catalog of my things

📗 Table of Contents

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

📖 [Ruby group capstone - Catalog of my things]

[Ruby group capstone - Catalog of my things] In this project, we created 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. The data is stored in JSON files but we also prepared a database with tables structure analogical to your program's class structure.

🛠 Built With

1- Ruby 3.2.2
2- PostgreSQL
3- Gitflow
4- Rubocop
5- RSpec

Tech Stack

Client

• Microverse

Ruby

• Ruby

Database

• PostgreSQL

Key Features

• [Added Item class in item.rb]
• [Added main.rb as console entry-point]
• [Added Book class to book.rb]
• [Added MusicAlbum class to musicalbum.rb]
• [Added Game class to game.rb]
• [Added Label class to label.rb]
• [Added Genre class to genre.rb]
• [Added Author class to author.rb]
• [Added methods to classes]
• [Preserved data in json files]
• [Preserved data in json files]
• [Added UI console options]
• [Added unit tests for all classes and methods]
• [Created schema.sql with tables that are analogical to the structure of classes created]
• [Added Video Intro]

(back to top)

💻 Getting Started

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

Video Intro

A short description of the project:

Video Intro

Prerequisites

In order to run this project you need:

Web Browser (Chrome recommended)
Code editor (VS recommended)
GitHub account

You need the following tools be installed in your computer:

• Git
• Ruby
• IDE

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone "https://github.com/beteland123/ruby-capstone.git"

Install

Install this project with:

  cd ruby-capstone
  
  bundle install

Usage

Go to your /ruby-capstone folder:

  cd ruby-capstone
  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec/

(back to top)

👥 Authors

👤 Micronaut Betel Andarge

• GitHub: @beteland123
• Twitter: @betelandarge
• LinkedIn: LinkedIn

👤 Micronaut JUAN DAVID DIAZ

• GitHub: @JuanDBta
• Twitter: @simplebetsas
• LinkedIn: LinkedIn

👤 Micronaut Sebastián Hernandez

• GitHub: @shm04
• LinkedIn: Sebastian Hernandez

(back to top)

🔭 Future Features

• [Add more options in the UI console]
• [Add more methods to all classes]

(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 give me a like, it doesn't cost you anything and it helps me a lot to keep working.

(back to top)

🙏 Acknowledgments

I would like to thank Bee in Student Success who is always avalaible to solve issues and Microverse for push us to work hard every day!

(back to top)

📝 License

This project is MIT licensed.

(back to top)