Luiscarlosvd/catalog-of-my-things

This project is a catalog of things where users can choose an option like creating Books, Music Albums, and Games with information like authors and genres. This app preserves the data for users in files and users can filter the information by listing the information about all authors, games, music albums, and more.

Catalog of my things

📗 Table of Contents

• 📗 Table of Contents
• 📖 Catalog of my things
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Catalog of my things

This project is a catalog of things where users can choose an option like creating Books, Music Albums, and Games with information like authors and genres. This app preserves the data for users in files and users can filter the information by listing the information about all authors, games, music albums, and more. You can see the description of the project here

🛠 Built With

Tech Stack

List of technologies used for this project

Client

• Ruby

Database

• PostgreSQL

Key Features

• Add Books, Music Albums and Games
• Preserve data in files
• List all things inside the app like genres, authors and labels

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

gem install ruby

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Luiscarlosvd/catalog-of-my-things

Install

Install this project with:

  cd catalog-of-my-things

Usage

To run the project, execute the following command:

ruby main.rb

Run tests

To run tests, run the following command:

rspec spec

(back to top)

👥 Authors

👤 Luis Valera

• GitHub: @Luiscarlosvd
• Twitter: @Luiscarlosvd29
• LinkedIn: Luis Valera

👤 Sergio Peralta

• GitHub: @SergioPeralta22
• Twitter: @SePeralta22
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Improve UI
• Add more tests
• Add more categories and labels

(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 it a ⭐️!

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us the opportunity to learn and grow as developers.

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)