Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/felipe-perez-ferraro/ruby_capstone


https://github.com/felipe-perez-ferraro/ruby_capstone

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Video Presentation](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)


# 🏫 Ruby Capstone Project

In this project, we are building a item library app using Ruby. The application allows managing items and store them.

## 🛠 Built With

### Tech Stack

Programming Language

### Key Features

- **Books Games and Music Albums:** Ability to add new items to the system.
- **Features Management:** Manage a list of features like authors,genres and labels in the library.
- **Save items & features:** Save you items and features created in json files.
- **Modular Design:** Built with Object-Oriented Programming (OOP) principles for easy scalability and maintenance.

(back to top)

## 🚀 Video Presentation
- [Project Presentation Video](https://drive.google.com/file/d/1T-ufxigvRGEox9Fk6buV5PiyoBPoe8us/view?usp=sharing)

(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:

- [ ] Ruby

### Setup

Clone this repository to your desired folder:

```bash
git clone https://github.com/Felipe-Perez-Ferraro/RUBY_Capstone.git
```

### Install

Go to the project directory.

```bash
cd RUBY_Capstone
```

### Usage

For now, the project is primarily command-line based. Detailed usage instructions will be added as the project evolves.

### Run tests

To run tests:

```test
rspec spec/models
```

(back to top)

## 👥 Authors

👤 **Zabih Noori**

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

👤 **Felipe Perez Ferraro**

- GitHub: [@Felipe-Perez-Ferraro](https://github.com/Felipe-Perez-Ferraro)

(back to top)

## 🔭 Future Features

Features to be added in upcoming iterations:

- Remove a selected book
- Add genre to selected book

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Felipe-Perez-Ferraro/RUBY_Capstone/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

Thanks to all community.

(back to top)

## 📝 License

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

(back to top)