Ngufor-emmanuella / Ruby-capstone-proj

Ruby Capstone Project: Catalog of my Things README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 CATALOG_OF_THINGS

**Catalog of things ** is a console application that will help you to keep a record of different types of things you own: books, music albums, movies, and games.

🛠 Built With

Tech Stack

Client

• Ruby

Database

• PostgreSQL

Key Features

• Add a new game, a music album and a book
• Add extra details such genre, label and authors
• All the data is persisted in JSON files

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

• A text editor preferably Visual Studio code
• Latest version of Ruby installed
• PostgreSQL Server

Setup

Clone this repository to your desired folder:

  
  git clone https://github.com/Ngufor-emmanuella/Ruby-capstone-proj.git
  cd Ruby-capstone-proj

Install

Install this project with:

  gem install

Usage

To run the project, execute the following command in your terminal:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Ngufor-emmanuella

• GitHub: @Ngufor-emmanuella
• Twitter: @Ngufor-emmanuella
• LinkedIn: @Ngufor-emmanuella

👤 Brian Buntu Ludidi

• GitHub: @Bludidi
• Twitter: @BB_Ludidi
• LinkedIn: Brian Ludidi

👤 NEJJARI ABDELHAFID

• GitHub: @Nejjari001
• Twitter: @AbdoNJ19
• LinkedIn: Abdelhafid Nejjari

(back to top)

🔭 Future Features

• A graphical user interface
• Better information validation
• A backend to store the data

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please leave a star 😁

(back to top)

🙏 Acknowledgments

We would like to thank the Microverse staff for all the efforts they put in define the requirements of this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I reuse this code?

  • Yes, feel free to fork it

• Do I need knowledge of Ruby to use this project?

  • No you do not.

(back to top)

📝 License

This project is MIT licensed.

(back to top)