Catalog 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

📖 Catalog Of My Things

Catalog of my things is a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. The data will be stored in JSON files but we will also prepare a database with tables structure analogical to your program's class structure.

🛠 Built With

Tech Stack

Client

• Ruby

Technology

• GitHub

Database

• PostgreSQL

Key Features

• Present the user with a list of options to choose and perform.
• Allow users to enter the parameter for their option
• Preserve data by saving collections in .json files
• Present a way for the users to quit the app

(back to top)

🚀 Video Demo

• Click Here To View Live

(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:

 sudo apt-get install ruby-full

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone git@github.com:tobuya/catalog_of_my_things.git

Install

Install this project with:

Example command:

  cd catalog_of_my_things.git
  gem install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec --pattern spec/*_spec.rb

Deployment

You can deploy this project on the console using:

  ruby main.rb

(back to top)

👥 Authors

👤 Thomas Obuya

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Pray Eddy Shimwa

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Ajayi Ridwan

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add more classes
• Implement more features

(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 star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank fellow Micronauts.

(back to top)

📝 License

This project is MIT licensed.

(back to top)