Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikennarichard/catalog-of-things
A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games.
https://github.com/ikennarichard/catalog-of-things
catalog microverse oop ruby
Last synced: 4 days ago
JSON representation
A console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games.
- Host: GitHub
- URL: https://github.com/ikennarichard/catalog-of-things
- Owner: ikennarichard
- License: mit
- Created: 2023-07-03T08:08:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-06T15:08:34.000Z (over 1 year ago)
- Last Synced: 2024-01-28T21:42:57.526Z (about 1 year ago)
- Topics: catalog, microverse, oop, ruby
- Language: Ruby
- Homepage:
- Size: 52.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- 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)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Project Name
## Catalog of My Things
>This is a console app that allows the user to keep a record of different types of things they owns: books, music albums and games.
- `Ruby`
- **Modular Implementation**
> Each class is implemented in a separate .rb file, allowing for easy management of the codebase.
- **Custom Setters**
> Custom setters for 1-to-many relationships allow for easy management of collections.
- **User Interface**
> The user interface provides users with a list of options to perform, making it easy to manage the system.
- **Data Persistence**
> All data is saved in .json files, ensuring that user data is preserved between sessions.
## 💻 Getting Started
To clone the repository in local environment try following steps.
### Prerequisites
- [x] A code editor like Visual Studio Code with Git and Node.js.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Node.js and npm for package installation.
```
$ ruby --version && gem --version
```
### Setup
Clone the repository using [this link](https://github.com/ikennarichard/Catalog-of-things/tree/group-task).
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/ikennarichard/Catalog-of-things/tree/group-task
```
### Get into development
In the terminal, run these commands to get into development.
```
$ cd catalogue-using-ruby
$ bundle init
$ bundle install (install dependencies)
$ ruby main.rb (run the app locally)
```
👤 **Hasnat**
- GitHub: [@hasnatali1947](https://github.com/hasnatali1947)
- Twitter: [@hasnatking1947](https://twitter.com/hasnatking1947)
- LinkedIn: [Hasnat ali](https://www.linkedin.com/feed/?trk=homepage-basic_google-sign-in-submit)
👤 **Atif Zada**
- GitHub: [@AtifZada](https://github.com/AtifZada)
- LinkedIn: [@AtifZada](https://linkedin.com/in/AtifZada)
👤 **Ikenna Richard**
- GitHub: [ikennarichard](https://github.com/ikennarichard)
- LinkedIn: [ikenna_richard](https://linkedin.com/in/ikenna_richard)
- [ ] **Removing selected items (book, game, albums)**
- [ ] **Add genre, label and author to selected items**
Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.
Feel free to check the [issues page](https://github.com/ikennarichard/Catalog-of-things/tree/group-task).
Give a ⭐️ if you like this project!
Authors would like to thank:
- [Microverse](https://www.microverse.org/)
- Coding Partners
This project is [MIT](./LICENCE) licensed.