MudasirSherwani/school-library

School library is a tool to record the books that are in the library and those who borrows them. Utilizes the principles of object oriented programming

School Library

📗 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
• 📝 License

📖 [School Library]

[School Library] is a tool to record the books that are in the library and those who borrows them.

🛠 Built With

Tech Stack

Backend

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

• install ruby if not already installed

 $ sudo apt install ruby

Setup

Clone this repository to your desired folder:

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

Install

Install this project with:

  $ cd school-library
  $ bundle install

Usage

To run the project, execute the following command:

  $ ruby main

Run tests

To run the tests, execute the following command:

  $ rspec

(back to top)

👥 Authors

👤 Yuvenal Njoroge

• GitHub: @yuvenalmash
• Twitter: @Juvenal
• LinkedIn: Yuvenal Njoroge

👤 Hassaan Baig

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add a front end

(back to top)

🤝 Contributing

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a star

(back to top)

🙏 Acknowledgments

I would like to thank the code reviewers for their assistance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)