📗 Table of Contents

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

📖 OOP-School-Library

This APP will allow you to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when. And all of this is done in a beautiful and well-organized way!

🛠 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
• Include Unit tests for TDD compliance

(back to top)

🚀 Live Demo

• Coming soon...

(back to top)

💻 Getting Started

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

• copy this link https://github.com/blase147/OOP-School-Library.git
• get the directory that you want to clone the repository.

Prerequisites

In order to run this project you need:

• A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
• Ruby installed on the Computer

Setup

open the command prompt in this directory.

• write git clone https://github.com/blase147/OOP-School-Library.git
• or git clone git@github.com/blase147/OOP-School-Library.git` if you prefer ssh and hit enter.
• create a directory in your preferred location (e.g in the Desktop or Document directory)

Install

Install this project with:

• Dependencies (a packet manager is required): then you run the command npm install in the terminal

Usage

To run the project, execute the following command:

• ruby -the name of the file-
• This will run the project in the terminal in the specified directory

Run tests

To run tests, run the following command:

• npm run test
• This will run all tests on your local machine

(back to top)

👥 Authors

👤 Chukwuma Paul Mosanya

GitHub | Twitter | LinkedIn

👤 Oluwatoyin Olaoye

• GitHub:
• Twitter:
• LinkedIn:

👤 Sammuel LEKPOR

• GitHub: @Samuellekpor
• Twitter: @samuel_lekpor
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

To be added later

(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 😄, a star would be a nice gift from you 🧑‍🚀

(back to top)

🙏 Acknowledgments

A big thanks to the Microverse Team

(back to top)

📝 License

This project is MIT licensed.

(back to top)