Recillah-Khamala / School-Library

With this beautiful and well-organized project, one is able to record what books are in the library and who borrows them. The app allows one to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when.

School Library README Template

📗 Table of Contents

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

📖 [School_Library]

With this beautiful and well-organized [School_Library] project, one is able to record what books are in the library and who borrows them. The app allows one to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when.

🛠 Built With

Tech Stack

Server

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

• 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

Clone this repository to your desired folder:

• Git clone [e-mail]:Recillah-Khamala/School-Library.git
• cd School_Library
• run bundle install
• run rubocop . to check for linters
• run ruby list.rb to run program

Run tests (For the linters added)

These were linter tests mainly

• run rubocop . to run all linter checks
• run rubocop -A to fix all fixable errors

👥 Author

👤 Recillah Khamala

• GitHub: @Recillah-Khamala
• Twitter: @recillahk
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse community.

(back to top)

📝 License

This project is MIT licensed.

(back to top)