Zuwairanajma/Catalog-of-my-things

Catalog-of-my-things

📗 Table of Contents

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

📖 [Catalog-of-my-things]

[Catalog-of-my-things] Is a console app that helps keep records of different types of things: books, music albums, and games.The data is stored in JSON files. A database with tables structure analogical to the program's class structure is prepared.

Video Presentation

• Click here to watch the video

(back to top)

🛠 Built With

Tech Stack

Ruby

• • Click here to read more about ruby

Key Features

• [Class functionality]

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

 bundle install

Setup

Clone this repository to your desired folder:

  cd Catalog-of-my-things
  git clone https://github.com/Zuwairanajma/Catalog-of-my-things.git

Install

Install this project with:

  cd catalog-of-my-things
  bundle install
  gem install --no-document rubocop -v '>= 1.0, < 2.0'
  gem install rspec

Usage

To run the project, execute the following command:

  ruby main.rb
  or
  ./main

Run tests

To run tests, run the following command:

• rubocop --color
• rspec spec --format doc

Deployment

• Project is not deployed

(back to top)

👥 Authors

👤 Author1 [Zuwaira Sadiq]

• GitHub: @Zuwairanajma
• Twitter: @SadiqJuwairiyya
• LinkedIn: Zuwaira Sadiq

👤 Author2 [Ricardo Egas]

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

👤 Author3 [Pushkar Gautam]

• GitHub: @pushkar1995
• Twitter: @Pushkar9951
• LinkedIn: pushkargautam

(back to top)

🔭 Future Features

• [Add different structure]

(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 show support by staring ⭐️.

(back to top)

🙏 Acknowledgments

• We would like to thank Microverse for accommodating us in the Full-time Software Development program

(back to top)

📝 License

This project is MIT licensed.

(back to top)