Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hassaanjbaig-code/catalog-of-my-things

This project involves creating a media cataloging system with a user interface and a database schema for storing data. This project build with the ruby and the data store in the JSON format
https://github.com/hassaanjbaig-code/catalog-of-my-things

json ruby sql

Last synced: 28 days ago
JSON representation

This project involves creating a media cataloging system with a user interface and a database schema for storing data. This project build with the ruby and the data store in the JSON format

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 my-catalog ](#-Enumerable-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Run tests](#run-tests)
- [Video walkthrough](#video-walkthrough)
- [👥 Authors ](#-authors-)
- [🔭 Future Features](#future-features)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Catalog of my things

- This project involves creating a media cataloging system with a user interface and a database schema for storing data.

(back to top)

## 🛠 Built With

### Tech Stack

### Key Features

- **Media cataloging system.**
- **User-friendly interface.**
- **Data storage in JSON.**

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- To install ruby in your PC. You can read [this](https://rubyinstaller.org/downloads/) documentation on how to do so
- Know how to navigate directories or folders at the CLI.
- Know how to get the URL(https/ssh) of a repository on GitHub.
- You should have a code editor installed, preferably VSCode.

### Setup

In desired folder or directory in the CLI, run the command:

```JavaScipt
cd clone https://github.com/RoyJumah/catalog-of-my-things.git
```

Navigate into the cloned folder or repository by running the command:

```JavaScript
cd
```

If VsCode is your default code editor, run:

```JavaScript
code .
```

To install the existing dependecies,run:
```JavaScript
bundle install
```

And finally if you want to have fun by entering data into the application, run
`ruby main.rb` and you will be provided with a list of what you can do

You are all set up!

(back to top)

### Run tests

To run tests, run the following command:

```sh
$ rspec --force-color --format documentation
```

(back to top)



### Video Walkthrough

- The [link](https://drive.google.com/file/d/10nQJ__1_6x_fZV_7pQkszlV35mwhVSvi/view?usp=share_link) to the video discussing about our application and its interesting features!

(back to top)

## 👥 Authors

👤 **Roy Jumah**

- GitHub: [@RoyJumah](https://github.com/RoyJumah)
- Twitter: [@\_royissues](https://twitter.com/_royissues)
- LinkedIn: [Roy Jumah](https://www.linkedin.com/in/roy-jumah/)

👤 **Hassaan Baig**

- GitHub: [@hassanBaig](https://github.com/Hassaanjbaig-code)
- LinkedIn: [hassanBaig](https://www.linkedin.com/in/hassaan-jawwad-baig/)

👤 **Kennedy Owusu**

- GitHub: [@kennedyowusu](https://github.com/kennedyowusu)
- Twitter: [@_iamkobby](https://twitter.com/@_iamkobby)
- LinkedIn: [@kennedyowusu](www.linkedin.com/in/kennedyowusu)

(back to top)

## 🔭 Future Features

- [ ] Search and filter media
- [ ] Add/edit media properties
- [ ] User authetication and permissions
- [ ] Integration with external APIs
- [ ] And all of this will be built in a beautiful and well-organized way!

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/RoyJumah/catalog-of-my-things/issues).

(back to top)

## ⭐️ Show your support

If you like this project you can give it a star

(back to top)

## 🙏 Acknowledgments

We would like to thank `Microverse` for providing us the resources that enabled us to finish this challenge!

(back to top)

## 📝 License

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

(back to top)