StarMindz/School-Library-on-Ruby

This is a useful tool for Librarians that helps to record what books are in the library, what books are not, and who borrows them

School-Library-on-Ruby

This is a useful tool for Librarians that helps to record what books are in the library, what books are not, and who borrows them

📗 Table of Contents

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

📖 [School Library]

This is a useful tool for Librarians that helps to record what books are in the library, what books are not, and who borrows them

🛠 Built With

• Ruby
• GitFlow

Describe the tech stack and include only the relevant sections that apply to your project.

  

Server

  

    
• Ruby
  

### Key Features <a name="key-features">

The tool allows librarians to

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

<p align="right">(<a href="#readme-top">back to top)

🚀 Live Demo

Link to live Demo

- Coming soon

(back to top)

💻 Getting Started

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

• clone the repo like this: ​ git clone https://github.com/StarMindz/School-Library-on-Rub

• To run code use the below command on terminal

  ruby person.rb

Prerequisites

• You need to have Ruby installed on your local machine

• Ruby bundler properly set up for installing dependencies

  Go here to get Ruby installer for windows > Windows Installer

  Go here to get Ruby installer for Linux > Linux Installer

  Go here to get Ruby installer for MacOS > MacOS Installer

Setup

• Git clone https://github.com/Efiamotu-1/OOP-School-Library.git
• cd school_library
• run bundle install
• run rubocop to check for linters
• run rubocop-a to fix linters

Usage

Use ruby to run ruby files on terminal when ruby has ben installed

👥 Authors

Mention all of the collaborators of this project.

👤 Stanley Nnamani Wisdom AKA StarMindz

• GitHub: @Starmindz
• LinkedIn: Stanley Nnamani

👤 Marcos Gualtero Lourenzo

• GitHub: @Goruchie
• Twitter: @Goruchie2
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Some Future Features :

• I will add more classes to the code
• I will implement frontend for user interaction using React

(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 it a star and also follow me on GitHub for future projects

(back to top)

🙏 Acknowledgments

• A Big Thank you🙏 to my friend Luis David from whom I gained inspiration during the course of building this project Thank you Luis, You are the best!!
• Thumb ups to all the Naija Afrobeat Musicians whose beautiful music made building this project more fun

(back to top)

📝 License

This project is MIT licensed.

(back to top)