MICHAELKITH/oop-library

📗 Table of Contents

• 📗 Table of Contents
• 📖OOP school library
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Install
    • Clone the repository
    • Check your Ruby version
    • Install dependencies
    • run program demo
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖OOP school library

OOP school library it will help implement OOP school library tasks.

🛠 Built With

Ruby

Tech Stack

Server

• Ruby

Key Features

• Add Person, Student, and Teacher classes.
• Use the "Decorator" design pattern.
• Add basic UI.
• Preserve data.
• Unit test.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• Ruby
• VSCode or IRB
• Windows/Ubuntu/WSL

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.

Clone the repository

git clone https://github.com/MICHAELKITH/oop-library.git
cd oop-library

Check your Ruby version

ruby -v

The ouput should start with something like ruby 3.2.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.2.2

Install dependencies

Using Bundler and Yarn:

bundle && yarn

run program demo

ruby main.rb

(back to top)

👥 Authors

👤 Michael Kithinji

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

(back to top)

🔭 Future Features

• Unit tests- [ ] [In progress...]

(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 give me a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse which provided me all knowledge about full stack development.

(back to top)

📝 License

This project is MIT licensed.

(back to top)