📗 Table of Contents

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

📖 School Library

School Library is a book-borrowing management tool designed specifically for the librarians. With this app, librarians can keep track of all books in the library, as well as who borrows them and when. The app offers a simple and intuitive command line interface, making it easy to add new students or teachers, and new books to the library.

🛠 Built With

Tech Stack

• Ruby

Key Features

• Add new students or teachers.
• Add new books.
• Save records of who borrowed a given book and when.

(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 to install Ruby

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Kweeka1/school-library.git

Install

Install this project with:

  cd school-library
  gem install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  bundle exec rspec

👥 Authors

👤 Mohamed Talbi

• GitHub: Mohamed Talbi

👤 Ifeanyi Oti

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

(back to top)

🔭 Future Features

• Add a web interface
• Save records in a database
• Add a web server

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Put a star if you like this project.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for project inspiration.

(back to top)

❓ FAQ (OPTIONAL)

• What version of Ruby does this project work on ?

  • Any version

(back to top)

📝 License

This project is MIT licensed.

(back to top)