Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/edi-sipka/catalog_of_things

Ruby app for storing favourite Book, Music Album or Game. You can also add a new book, music album or game.
https://github.com/edi-sipka/catalog_of_things

ruby

Last synced: 6 days ago
JSON representation

Ruby app for storing favourite Book, Music Album or Game. You can also add a new book, music album or game.

Awesome Lists containing this project

README

        

# 📖 [Catalog_of_Things]

> Ruby app for storing favourite Book, Music Album or Game.
> You can also add a new book, music album or game.

## 🛠 Built With

### Tech Stack

BackEnd

Test

Database

### Key Features

- **[Add Book]** - Add your favourite book.
- **[Add Music Album]** - Add your favourite music album.
- **[Add Game]** - Add your favourite game.

(back to top)

## 🚀 Video

- [Video Team Link](https://drive.google.com/file/d/1IulqqGzJ36PvJYbTph8Ev_pBT6aa85kH/view)

(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: Visual Studio Code and Installed Ruby.

### Setup

Clone this repository to your desired folder:

```bash command
$ git clone https://github.com/edi-sipka/Catalog_of_Things
```

### Install

Install this project with:

```bash command
you@your-Pc-name:~$ cd
```

### Usage

To run the project, execute the following command:

```bash command
ruby main.rb
```

### Run tests

To run tests, run the following command:
rspec

(back to top)

## 👥 Authors

👤 _Edi Sipka_

- GitHub: [@Edi-Sipka](https://github.com/edi-sipka)
- Twitter: [@sipka_edii](https://twitter.com/sipka_edii)
- LinkedIn: [Edi Sipka](https://www.linkedin.com/in/edi-%C5%A1ipka-5b681b202/)

👤 **Aamir Khan**

- GitHub: [@aamirkhan2478](https://github.com/aamirkhan2478)
- LinkedIn: [LinkedIn](https://linkedin.com/in/aamir-kh)

👤 **Betsegaw Sebsibe**

- GitHub: [@Betse_s](https://github.com/betses)
- Twitter: [@Betse_s](https://twitter.com/Betse_s)
- LinkedIn: [Betsegaw Sebsibe](https://www.linkedin.com/in/betsegaw-sebsibe/)

(back to top)

## 🔭 Future Features

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

- [ ] **[Remove a selected book]**
- [ ] **[Remove a selected music album]**
- [ ] **[Remove a selected game]**

(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

If you like this project give as a star! ⭐️

(back to top)

## 🙏 Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- Microverse

(back to top)

## ❓ FAQ

- **[How I can run this project?]**

- [After cloning repository, run ruby main.rb. After that, you will see 10 different options, so you can select option that you want to use]

- **[After adding, where is my data stored?]**

- [All data will be stored in JSON files.]

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)