https://github.com/heintayzar-hm/catalog-of-things
https://github.com/heintayzar-hm/catalog-of-things
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/heintayzar-hm/catalog-of-things
- Owner: heintayzar-hm
- License: mit
- Created: 2023-02-13T07:32:18.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-16T14:09:19.000Z (over 2 years ago)
- Last Synced: 2025-02-07T23:46:01.476Z (4 months ago)
- Language: Ruby
- Size: 730 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
Microverse README Template
**[Catalog of My Things]** is a console app that allows users to keep a record of different types of things they own, such as books, music albums, movies, and games. It is based on a UML class diagram and stores data in JSON files and a database with tables structure analogical to the program class structure.
## A brief description on the project
[Video description](https://drive.google.com/file/d/11h7qttekDyAzw_9kc7lsTDGBxuK6bspd/view?usp=sharing)
Database
- **[Stores data in json file]**
- **[Add several types of items]**
- **[show the list of items stored in it]**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
Ruby installed on your machine
```
### Setup
Clone this repository to your desired folder:
**clone repo to your desired folder:**
```sh
git clone [email protected]:heintayzar-hm/catalog-of-things.git
```
### Install
Install this project with:
```sh
cd catalog-of-things
bundle install
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
To run tests, run the following command:
```sh
rspec
```
👤 **Ibrahim Suhail Al-Yousefi**
- GitHub: [@cluab](https://github.com/Cluab)
- Twitter: [@cluab122](https://twitter.com/cluab122)
- LinkedIn: [Ebrahim Al-Yousefi](https://www.linkedin.com/in/ebrahim-alyousefi/)
- Instagram: [@27.i.b](https://www.instagram.com/27.i.b/)
👤 **Andrea Tamara Diegaardt**
- GitHub: [@TechnoAndy](https://github.com/TechnoAndy)
- Twitter: [ADiegaardt](https://twitter.com/ADiegaardt)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/andy-diegaardt/)
👤 **Hein Tay Zar**
- GitHub: [@Hein Tay](https://github.com/heintayzar-hm)
- Twitter: [@Hein Tay](https://twitter.com/heintayzarhm)
- LinkedIn: [Hein Tay](https://www.linkedin.com/in/hein-tay-zar)
- [ ] **[Delete items]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/heintayzar-hm/catalog-of-things/issues).
If you like this project give it a star.
I would like to thank Microverse and my teammates for the idea of this project.
- **What type of Structured Query Language did we use for the database schema?**
- We used PostgreSQL for the database schema. The schema is defined in the schema.sql file.
- **Where are the application features linked for display on the user interface?**
- The application features are linked and implemented in the main.rb file. The main.rb file serves as the entry point for the console application and allows users to manage collections of the things they own. The console app presents a list of options to perform, allows users to choose an option, and prompts them for any necessary parameters. The user interface also makes use of the data stored in the database and JSON files to display information about the user's collections.
This project is [MIT](./License) licensed.