Kaweesi-Matia/catalog-of-my-things

In this project, we will create a console app that will help you to keep a record of different types of things you people own: books, music albums, and games. Everything will be based on a UML class diagram. The data will be stored in JSON files but a database with tables structure analogical to the program's class structure will be prepared.

Catalogue_Of_My_Things

📗 Table of Contents

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

📖 [Catalogue_Of_My_Things]

[Catalogue_Of_My_Things] is a console app that will help to keep a record of different types of things one owns: books, music albums, and games. Everything is based on the UML class diagram. The data is stored in JSON files but we also prepare a database with tables structure analogical the program's class structure.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Option to list all available items in the Catalogue]
• [Option to add items in the catalogue]
• [Option to archive catalogue items]

(back to top)

🚀 Demo Link

• Project Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

  https://github.com/Recillah-Khamala/Catalogue_Of_My_Things.git

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd catalog-of-my-things

Install

Install this project with:

  bundle install

Usage

To run the project, execute the following command:

• After Cloning this repo to your local machine.
• To get it running on your machine, you may open the project on your IDE and open the terminal
• On the terminal you can run:

ruby main.rb

• After, you can follow along the app and run the appropriate option from list to interact with it.

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Recillah Khamala

• GitHub: @Recillah-Khamala
• Twitter: @recillahk
• LinkedIn: Recillah Khamala

👤 Kaweesi Matia

• GitHub: @Kaweesi-Matia
• Twitter: @kaweesimatia
• LinkedIn: Kaweesi Matia

👤 Tashobya Israel

• GitHub: @tashisrael
• Twitter: @tashisrael
• Linkedin: Tashobya Israel

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Feature to add other things in the catalogue]
• [Option to delete archived]

(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 give it a ⭐️ or contact us.

(back to top)

🙏 Acknowledgments

I would like to thank microverse for adding this into the carriculum

(back to top)

📝 License

This project is MIT licensed.

(back to top)