Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mwafrika/catalogue-of-my-things-ruby

In this project, we create a console app that will help user to keep a record of different types of things he won: books, music albums, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but we also prepare a database with tables structure analogical to our program's class structure.
https://github.com/mwafrika/catalogue-of-my-things-ruby

ruby ruby-gem

Last synced: 2 days ago
JSON representation

In this project, we create a console app that will help user to keep a record of different types of things he won: books, music albums, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but we also prepare a database with tables structure analogical to our program's class structure.

Awesome Lists containing this project

README

        

# Catalog of My Things (Ruby Group Capstone Project)

> In this project, we create a console app that will help user to keep a record of different types of things he won: books, music albums, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but we also prepare a database with tables structure analogical to our program's class structure.

![schema](https://github.com/microverseinc/curriculum-ruby/blob/main/group-capstone/images/catalog_of_my_things.png)

## Built With

### Languages

- Ruby
- SQL

### Tools

- Git
- GitHub
- Visual Studio Code

## Link Video

[Video Demo Link]()

## Getting Started

You will be needing:

- A terminal
- A code editor
- Ruby (follow the instruction based on your OS)

`https://www.ruby-lang.org/en/documentation/installation/`

### Setup

### Clone this repository

`git clone https://github.com/cynthiainga/ruby-group-capstone.git`

### Move into the directory with

`cd ruby-group-capstone`

### Run Project

`ruby main.rb`

### Install linter

`bundle install`

### Run linter

`rubocop`

### Run tests

`rspec spec`

### Auto-correct

In auto-correct mode, RuboCop will try to automatically fix offenses:

`rubocop -A`

**OR**

`rubocop --auto-correct-all`

## Authors

👤 **Candy Inga Cynthia**

- GitHub: [@cynthiainga](https://github.com/cynthiainga)
- Twitter: [@CynthiaInga_C](https://twitter.com/CynthiaInga_C)
- LinkedIn: [Cynthia Inga](https://www.linkedin.com/in/cynthia-inga/)

👤 **Mwafrika Josue**

- GitHub: [@mwafrika](https://github.com/mwafrika)
- Twitter: [@mwafrika](@mwafrikamufung1)
- LinkedIn: [Mwafrika Mufungizi](https://www.linkedin.com/in/mwafrika-mufungizi/)

👤 **damdafayton**

- GitHub: [@damdafayton](https://github.com/damdafayton)
- LinkedIn: [@damdafayton](https://linkedin.com/in/damdafayton)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/cynthiainga/ruby-group-capstone/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Thanks to everyone who will get time to check this project especially to code reviewers.
## 📝 License

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