Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gardimy/ruby_capstone_project

In this project, I add a console app that allows users to manage their collection of books, music albums, movies, and games. The app follows the provided UML class diagram and incorporates features such as adding items, archiving, and displaying lists of various categories.
https://github.com/gardimy/ruby_capstone_project

ruby

Last synced: 3 days ago
JSON representation

In this project, I add a console app that allows users to manage their collection of books, music albums, movies, and games. The app follows the provided UML class diagram and incorporates features such as adding items, archiving, and displaying lists of various categories.

Awesome Lists containing this project

README

        




Ruby group capstone - Catalog of my things



# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Ruby group capstone - Catalog of my things

**Catalog of my things** In this project, my coding partners and I create a console app that help us to keep a record of different types of things our own: books, music albums, movies, and games. Everything's base on the UML class diagram provide for the exercice. The data store in JSON files but we prepare a database with tables structure analogical to our program's class structure.
## 🛠 Built With

### Tech Stack
### Built With

#### Tech Stack

- Ruby

#### Key Features

- `Add user interactivity` It implements a command line for user to select options and interact with App.
- `Based on UML graphic` Includes a database design that we will use later to conect to a real progres SQL.
- `Used linters for cleaner code` No linter errors.

### video walkthrough

https://drive.google.com/file/d/1DEGvmH0Q8BrZ0-3jheuD2PCcDLtL8cRU/view?usp=drive_link

## 💻 Getting Started

- Step 1: Clone this project using this git comand "git clone", (if you don't have git installed please visit
https://git-scm.com/downloads and install it).
- Step 2: Once you have installed git you can clone this project using the command below:
```
https://github.com/ahmed025566/Catalog_of_my_things
```
- Step 3: Once you have cloned this repo navigate to the folder that contains
the repository.

- Step 4: If you want to edit this project open it with your favorite text editor.

(back to top)

## 💻 Getting Started

To get a local copy up and running cloning this repo `https://github.com/ahmed025566/Catalog_of_my_things`.

### Prerequisites

> You need the following tools be installed in your computer:

> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - IDE
> - Etc

### Setup

Clone this repository to your desired folder:

`https://github.com/ahmed025566/Catalog_of_my_things`

or

`https://github.com/ahmed025566/Catalog_of_my_things` <-- _Only if you have [SSH keys configured](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) on your GitHub account_.

### Install

Install this project with:

```sh
cd Catalog_of_my_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 spec/
```
...

## 👥 Authors

> 👤 **Gardimy Charles**

- GitHub: [@Gardimy](https://github.com/Gardimy)
- Twitter: [@gardyelontiga45](https://twitter.com/gardyelontiga45)
- LinkedIn: [Gardimy charles](https://www.linkedin.com/in/gardimy-charles)

👤 **Ahmed Elkholy**

- GitHub: [@ahmed](https://github.com/ahmed025566)
- Twitter: [@AhmedEl18692792](https://twitter.com/AhmedEl18692792)
- LinkedIn: [Ahmed Salah](https://www.linkedin.com/in/ahmed-salah025566/)

👤 **Ali Bello Imoukhuede**

- GitHub: [@githubhandle](https://github.com/devalibello)
- Twitter: [@twitterhandle](https://twitter.com/i_am_aalee)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ali-bello-imoukhuede/)

(back to top)

## 🔭 Future Features

- Will add more data
- Will use database instead of JSON file to save data

(back to top)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please give me a start and share my portfolio to recruters!

(back to top)

## 🙏 Acknowledgments

I would like to thank to [microverse](https://www.microverse.org/) For teaching me the database and more things.

(back to top)

## 📝 License

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

(back to top)