📗 Table of Contents

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

• 📝 License

📖 About the Project

School Library is an app design using Object Oriented Programming method that is capable of:

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

It's based upon this diagram:

🛠 Built With

Tech Stack

Server

• Ruby

(back to top)

Key Features

• Add new Students
• Add new Teachers
• Add new Books
• Add new Borrow record

(back to top)

💻 Getting Started

 bundle install

Prerequisites

In order to run this project you need: Ruby

You need Bundler and also rubocop to check for linter errors

(back to top)

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/dev89s/school-library.git

Install

After you installed ruby on your system, you can go on and installed the linter "rubocop" to check for any linter errors in your code. To do so, you need ruby bundler which can be installed:

  gem install bundler

Then initialize the bundler by

  bundle init

Which will create the gem file, and then add the folloing line to the gem file

  gem 'rubocop', '>= 1.0', '< 2.0'

To install the dependencies:

  bundle install

And also to install rubocop for linter errors checking:

  gem install rubocop

👥 Authors

👤 Sasan Moshirabadi

• GitHub: @dev89s
• LinkedIn: LinkedIn

👤 Author: Damilare

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

(back to top)

🔭 Future Features

• Add a frontend UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to give any recommendations issues page.

(back to top)

⭐️ Show your support

If you like this project consider giving it a star on GitHub!

(back to top)

🙏 Acknowledgments

I would like to thank my family for always being there & supporting me through hard times.

(back to top)

📝 License

This project is MIT licensed.

(back to top)