📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • video Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 [Catalogue Of My Things]

Catalogue Of My Things is a ruby project that list one's items.

🛠 Built With

Tech Stack

Server

• Ruby

Video Presentation

A video of the project Video Presentation

Key Features

• File Persistence
• Object Oriented Programming
• CRUD Operations
• Intuitive Terminal User Interface
• Unit Testing

(back to top)

💻 Getting Started

Prerequisites

• Ruby:

Install

To install on Mac Os run following commands:

 brew install rbenv ruby-build
# Add rbenv to bash so that it loads every time you open a terminal
echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
source ~/.bash_profile

# Install Ruby
rbenv install 3.0.1
rbenv global 3.0.1
ruby -v

Installing Ruby on Windows is a little more difficult than installing it on another OS. We would recommend using WSL, but you can also try to install Ruby directly on your OS with rubyinstaller.

Note: WSL only works on 64-bit installations of Windows.

If you are using a 64-bit version of Windows 10, we recommend following this article to install Ruby.

If you can not use WSL then you should follow these steps:

• Download the last version of RubyInstaller.
• Run RubyInstaller and follow the steps described here.

If you are familiar with docker, you could also use it.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:MosDevx/Ruby-Capstone.git

Usage

If you have ruby installed in your PC the simply start IRB(Interactive Ruby Shell) on terminal using:

  $ irb

Thats it now you can execute your program on terminal:)

(back to top)

👥 Authors

👤 Alwyn Androvelle

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Kaung Myat Kyaw

• GitHub: GitHub
• Twitter: Twitter
• LinkedIn: LinkedIn

👤 Moses Wamae

• GitHub: @mosdevx
• Twitter: @moseswamae7
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Live Demo]
• [Video Presentation]
• [Documentation]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

📝 License

This project is MIT licensed.

(back to top)