oop-school-lib

📗 Table of Contents

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

📖 [oop-school-lib]

[oop-school-lib] Is an app a Librarian at a school university uses to create new user (students/teachers), add new books, and save records of who borrowed a given book and when.

🛠 Built With

Tech Stack

Ruby

• https://www.ruby-lang.org/en/

Key Features

• [Class functionality]

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

 bundle install

Setup

Clone this repository to your desired folder:

  cd oop-school-lib
  git clone https://github.com/stephenkati/oop-school-lib.git

Install

Install this project with:

  cd oop-school-lib
  bundle install
  gem install --no-document rubocop -v '>= 1.0, < 2.0'
  gem install rspec

Usage

To run the project, execute the following command:

• ruby main.rb or
• ./main

Run tests

To run tests, run the following command:

• rubocop --color
• rspec spec --format doc

Deployment

• N/A

(back to top)

👥 Authors

👤 STEPHEN KATULI

• GitHub: @ehmaddd
• LinkedIn: @ehmaddd
• Twitter: @ehmaddd_pk

👤 AHMAD SAEED

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Add different structure]

(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 show support by staring ⭐️.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for accommodating us in the Full-time Software Development program.

(back to top)

📝 License

This project is MIT licensed.

(back to top)