An open API service indexing awesome lists of open source software.

https://github.com/microverse-fullstack-program/school_library

This OOP based Library Application allow to store a list of books and people who borrow it. The app also allows you to create your membership as a student or teacher, you can also rent a book and the application keeps track of the books rented and the dates they were rented on. Built with Ruby.
https://github.com/microverse-fullstack-program/school_library

rpsec rubocop rubocop-rspec ruby ruby-gem

Last synced: 5 months ago
JSON representation

This OOP based Library Application allow to store a list of books and people who borrow it. The app also allows you to create your membership as a student or teacher, you can also rent a book and the application keeps track of the books rented and the dates they were rented on. Built with Ruby.

Awesome Lists containing this project

README

          

# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 OOP School Library ](#-oop-school-library-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 OOP School Library

**OOP school library** a tool that allows librarian to record what books are in the library and who borrows them. More specifically, the app will allow you to:
> - Add new students or teachers.
> - Add new books.
> - Save records of who borrowed a given book and when.

## 🛠 Built With

### Tech Stack

> The tech stack in this project includes.

Ruby

### Key Features

- **Implemented with ruby OOP principles**

(back to top)

## 🚀 Live Demo

- Not available

(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: **Ruby installed**.

```sh
gem install ruby
```

### Setup

- Clone [this repository](https://github.com/Microverse-Fullstack-Program/school_library) to your desired folder.
- Alternatively, you can download the zip file of your project by clicking on the Code button on the right side of your project page and clicking on Download ZIP

### Install

Install this project with:

```sh
cd my-project
gem install ruby
```

### Usage

To run the project, execute the following command:

- Install Ruby.
- Install Ruby Gem

### Run tests

To run tests, run the following command: **Not available**.

### Deployment

You can deploy this project using: **Not available**.

(back to top)

## 👥 Authors

👤 **Chere Lemma**

- GitHub: [@githubhandle](https://github.com/cherelemma)
- Twitter: [@twitterhandle](https://twitter.com/Chere21271613)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chere-lemma27211613)

👤 **Henry Omondi**

- GitHub: [@githubhandle](https://github.com/Odongo006)
- Twitter: [@twitterhandle](twitter.com/HenryOdongo007)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/henry-odongo/)

(back to top)

## 🔭 Future Features

In the future work,
- [ ] **Unit tests**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Microverse-Fullstack-Program/school_library/issues).

(back to top)

## ⭐️ Show your support

If you like this project give a ⭐️.

(back to top)

## 🙏 Acknowledgments

I would like to thank [Microverseinc: OOP school library: add Person, Student and Teacher classes
](https://github.com/microverseinc/curriculum-ruby/blob/main/oop/school_library_people.md) for the project requirment.

(back to top)

## ❓ FAQ

- **For what purpose this project can be used**

- The project can be used to learn and get hand on exprience on OOP concepts in RUBY.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)