Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssekpius/microverse-catalog
https://github.com/ssekpius/microverse-catalog
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ssekpius/microverse-catalog
- Owner: SSEKPIUS
- License: mit
- Created: 2023-03-03T11:37:44.000Z (almost 2 years ago)
- Default Branch: Add-unit-tests-for-all-implemented-methods-
- Last Pushed: 2023-03-03T11:38:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-20T13:19:03.571Z (3 months ago)
- Language: Ruby
- Size: 580 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)**Catalog Of My Things** Is a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything was based on the UML class diagram presented. The use data will be preserved in a json file.
Client
Database
- **keep a record of different types of things you own: books, music albums, movies, and games.**
- **List all your data when the option is selected**
- **Store user data to the storage**
- [Project Video Demo Link](#)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
You need to have ruby installed
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/SekoViper/Catalog.git
```
-
### Install
Install this project with:
Example command:
```sh
cd catalog
bundle install
```
-
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
-
### Run tests
To run tests, run the following command:
Example command:
```sh
rspec spec --format documentation
```
-
👤 **Author1**
- GitHub: [@SekoViper](https://github.com/SekoViper)
- LinkedIn: [@valentine-blaze](https://www.linkedin.com/in/livingstone-dameh/)
👤 **Author2**
- GitHub: [@SSEKPIUS](https://github.com/SSEKPIUS)
- LinkedIn: [piusssekweyama](https://www.linkedin.com/in/piusssekweyama/)
> Describe 1 - 3 features you will add to the project.
- [ ] **remove a selected book**
- [ ] **add genre to selected book**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project please give it a star
> Give credit to everyone who inspired your codebase.
I would like to thank Microverse
This project is [MIT](./MIT.md) licensed.