rivasbolinga / school-library

An app that works as a tool for a library that keeps track of all the books as well as who borrows them.

School Library

School Library is an app for library management. It works as a tool for a library that keeps track of all the books as well as who borrows them.

📗 Table of Contents

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

📖 About the project

This project is done as part of Microverse program with the goal of perfectionate the use of Object Oriented Program in Ruby. Part of a collaborative project. The goal is to create an app where the user can interact with in order to manage the School Library adding books, people and rentals.

🛠 Built With

Tech Stack

Key Features

For this app the users can chose between 7 options in the command:

1 - List all books.

2 - List all people.

3 - Create a person (teacher or student, not a plain Person).

4 - Create a book.

5 - Create a rental.

6 - List all rentals for a given person id.

7 - Exit app.

We have also done some improvements as part of a collaborative session:

• Refactored the code using DRY, KISS and YAGNI and SOLID principles.
• Preserve data in json files.
• Refactored respective methods for listing data from json files.
• Created new methods for saving data, loading data and displaying preserved data from json files.
• Test all the classes.

(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. To install ruby in your machine you can follow the steps listed in the Ruby installation instructions guide

Setup

Clone this repository to your desired folder:

  cd school-library
  git clone [e-mail]:myaccount/my-project.git

Usage

To start the app, run the command:

  ruby main.rb

(back to top)

👥 Authors

👤 Andrea Rivas

• GitHub: @rivasbolinga
• LinkedIn: Andrea Rivas

👤 Baqar Abbas

• GitHub: @Baqar
• Twitter: @BaqarAbbas9
• LinkedIn: Baqar Abbas

(back to top)

🔮 Future Features

• Increase data storage options.

(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 give it a star 🌟🌟🌟

(back to top)

🙏 Acknowledgments

I would like to thank and my partner Baqar for his participation in this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)