Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lucas-erkana/ruby_template

This template is for Ruby users
https://github.com/lucas-erkana/ruby_template

Last synced: about 1 month ago
JSON representation

This template is for Ruby users

Awesome Lists containing this project

README

        

Versatile-Media

# 📗 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)

# 📖 Versatile-Media-Ruby

- Ruby app for storing favourite Books, Music Albums or Games.

- You can also add a new book, music album or game.

## 🛠 Built With

- Ruby

### Tech Stack

Client


  • Ruby

Test


  • RSPEC

Database


  • PostgreSQL

### Key Features

- **Add Book** - Add your favourite book.
- **Add a Music Album** - Add your favourite music album.
- **Add a Game** - Add your favourite game.

(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: any web-browser.

### Setup

Clone this [repository](https://github.com/Lucash2022/Versatile-Media-Ruby) to your desired folder.

### Install

This project does not require installation.

### Usage

**To run the project follow the following instruction:-**

- Clone this [repository](https://github.com/Lcuash2022/Versatile-Media-Ruby) in your local machine with correct branch.
- Run **ruby main.rb**

### Run tests

To run tests, run the following command: **rspec**.

(back to top)

## 👥 Authors

👤 **Lucas Erkana**

- GitHub: [@Lucash2022](https://github.com/Lucash2022)
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)

👤 **Partner 1**

👤 **Partner 2**

(back to top)

## 🔭 Future Features

- [ ] **Remove a selected book**
- [ ] **Remove a selected music album**
- [ ] **Remove a selected game**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project give a ⭐️.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

## ❓ FAQ (OPTIONAL)

- **[Can I use this project?]**

- [It's MIT license, feel free to use as you like.]

(back to top)

## 📝 License

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

(back to top)