Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ssekpius/microverse-catalog


https://github.com/ssekpius/microverse-catalog

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        


Catalog Of My Things

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#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. Everything was based on the UML class diagram presented. The use data will be preserved in a json file.

## 🛠 Built With

### Tech Stack

Client

Database

### Key Features

- **keep a record of different types of things you own: books, music albums, movies, and games.**
- **List all your data when the option is selected**
- **Store user data to the storage**

(back to top)

## 🚀 Project Video

- [Project Video Demo Link](#)

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

```sh
You need to have ruby installed
```

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/SekoViper/Catalog.git
```
-

### Install

Install this project with:

Example command:

```sh
cd catalog
bundle install
```
-

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```
-

### Run tests

To run tests, run the following command:

Example command:

```sh
rspec spec --format documentation
```
-

(back to top)

## 👥 Authors

👤 **Author1**

- GitHub: [@SekoViper](https://github.com/SekoViper)
- LinkedIn: [@valentine-blaze](https://www.linkedin.com/in/livingstone-dameh/)

👤 **Author2**

- GitHub: [@SSEKPIUS](https://github.com/SSEKPIUS)
- LinkedIn: [piusssekweyama](https://www.linkedin.com/in/piusssekweyama/)

(back to top)

## 🔭 Future Features

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

- [ ] **remove a selected book**
- [ ] **add genre to selected book**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project please give it a star

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank Microverse

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)