Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/catalog-of-my-things

catalog-of-my-things-prac Is a console app that will help keep a record of different types of things: books, music albums, movies, and games.The data is stored in JSON files. A database with tables structure analogical to the program's class structure is prepared.
https://github.com/stephenkati/catalog-of-my-things

postgresql ruby

Last synced: 23 days ago
JSON representation

Host: GitHub
URL: https://github.com/stephenkati/catalog-of-my-things
Owner: stephenkati
License: mit
Created: 2023-05-29T12:08:24.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-07-07T08:00:51.000Z (over 1 year ago)
Last Synced: 2024-10-03T00:41:54.025Z (about 1 month ago)
Topics: postgresql, ruby
Language: Ruby
Homepage:
Size: 45.9 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 16
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)

    - [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](#faq)

- [📝 License](#license)

# 📖 [catalog-of-my-things] 

**[catalog-of-my-things]** Is a console app that will help keep a record of different types of things: **books**, **music albums**, **movies**, and **games**.The data is stored in JSON files. A database with tables structure analogical to the program's class structure is prepared.

## 🛠 Built With 

### Tech Stack 

  Ruby

  


    https://www.ruby-lang.org/en/

  


### Key Features 

- **[Class functionality]**

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

```sh

 bundle install

```

### Setup

Clone this repository to your desired folder:

```sh

  cd catalog-of-my-things

  git clone https://github.com/stephenkati/catalog-of-my-things.git

```

### Install

Install this project with:

```sh

  cd catalog-of-my-things

  bundle install

  gem install --no-document rubocop -v '>= 1.0, < 2.0'

  gem install rspec

```

### Usage

To run the project, execute the following command:

```sh

  ruby main.rb

  or

  ./main

```

### Run tests

To run tests, run the following command:

- `rubocop --color`

- `rspec spec --format doc`

### Deployment

  - Project is not deployed

(back to top)


## 👥 Authors 

👤 **Author1**

 *[STEPHEN KATULI]*

 

- GitHub: [@githubhandle](https://github.com/stephenkati)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)


## 🔭 Future Features 

- [ ] **[Add different structure]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project please show support by staring ⭐️.

(back to top)


## 🙏 Acknowledgments 

* We would like to thank Microverse for accommodating us in the Full-time Software Development program.

(back to top)


## 📝 License 

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

(back to top)