Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mesakduducoder/item_catalog
This project is a collaboration project for ruby capstone week of Microverse program. This ruby application lets a user catalog their favourite books, games and music album. All their data is safely stored locally using JSON.
https://github.com/mesakduducoder/item_catalog
Last synced: 7 days ago
JSON representation
This project is a collaboration project for ruby capstone week of Microverse program. This ruby application lets a user catalog their favourite books, games and music album. All their data is safely stored locally using JSON.
- Host: GitHub
- URL: https://github.com/mesakduducoder/item_catalog
- Owner: MesakDuduCoder
- License: mit
- Created: 2023-09-11T07:33:00.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-12T13:57:20.000Z (over 1 year ago)
- Last Synced: 2024-04-15T10:28:31.820Z (10 months ago)
- Language: Ruby
- Size: 150 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [Video presentation](#video-presentation)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
## Description
In **Catalog of my things** project, we created a console app that will help user to keep a record of different types of things they own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data is preserved in JSON files. However we have also prepared a database with tables structure analogical to program's class structure.
### Video presentation
[Check out the video presentation](https://youtu.be/8AqvrGVGGpc)
Key features of the application
- Set up associations as per UML diagram
- Add basic UI
- Preserve data into JSON
- Unit tests
- Prepared Schema for tables structure.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Interactive Ruby.
- Code Editor.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
gh repo clone hhttps://github.com/MesakDuduCoder/item_catalog.git
```
### Installation
Install **Ruby Installer** using this link
### Usage
To run the project, execute the following command:
```
ruby main.rb
```
To run the project, execute the following command:
```
rspec spec --format documentation
```
or
```
rspec spec
```
👤 **MesakDuduCoder**
- GitHub: [@githubhandle](https://github.com/MesakDuduCoder)
- Twitter: [@twitterhandle](https://twitter.com/mesak_10)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mesak-lalrindika/)
👤 **Zuheb Ahmed**
- GitHub: [ @githubhandle](https://github.com/zuhebahmed88091)
- Twitter: [ @twitterhandle](https://twitter.com/ZuhebAhmed88091)
- LinkedIn: [ LinkedIn](https://www.linkedin.com/in/zuheb-ahmed/)
👤 **MD. Nohain Islam**
- GitHub: [ @githubhandle](https://github.com/Zafron047)
- Twitter: [ @twitterhandle](https://twitter.com/NohainZ)
- LinkedIn: [ LinkedIn](https://www.linkedin.com/in/nohain-islam/)
- **Stay tuned** to have more exciting features.
Contributions, issues, and feature requests are welcome!
Feel free to check the Issues.
If you like this project, show your support by giving the project a star ⭐️, thanks in advance.
I would like to thank Microverse for including this in their curriculum.
This project is [MIT](./LICENSE) licensed.