aron-net / catalog-of-my-things

This repo holds a command line interface app built with Ruby that will help users to keep a record of different types of things, like books, music albums, movies, and games. The app is based on the UML class diagram provided in the README and includes a database schema analogical to the class structuture of the app.

Catalog-of-my-Things 💿 📚 📝

This repo holds a command line interface app built with Ruby that will help users to keep a record of different types of things, like books, music albums, movies, and games. The app is based on the UML class diagram provided in the README and includes a database schema analogical to the class structuture of the app.

Built With 🛠️

• Ruby: Popular programming language that’s used for lots of things, from web app development to data analysis.
• GitHub flow: Correct use of Branches for deployment and features development.
• Linters Check (Rubocop): Local and Pull Request check for errors, bugs and stylistic errors in code.
• RSpec: Unit test framework for the Ruby programming language.
• SQL: A standardized programming language that is used to manage relational databases and perform various operations on the data.

UML Diagram structure

Getting Started ➡️

To get a local copy up and running follow these simple steps.:arrow_down:

Prerequisites ✅

• A code editor like Visual Studio Code with Git and Ruby.
• You can check if Git is installed by running the following command in the terminal:

$ git --version

Likewise for Ruby installation.

$ ruby --version

Setup

1. Clone the GitHub repository using the this link 🔗
2. Checkout to the dev branch
3. Run $ bundle install in your terminal to install all gems required to run the app.

Test

In the terminal, you can try running ruby main.rb or ./main.rb to start the app and display the user options. Use the keyboard to input options.

Authors ✍️

👩‍💻 Karla Delgado ✍️

• GitHub: @karlavdelgadof
• Twitter: @karlavdelgadof
• LinkedIn: Karla Delgado

👨‍💻 Aron Abraham ✍️

• GitHub: @Aaron
• LinkedIn: Aaron Abraham

👨‍💻 Karam Fouad ✍️

• GitHub: @karam084
• Twitter: @ElarabFouad
• LinkedIn: Karam Fouad

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.