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

https://github.com/sahlminkok/school-library

School Library is designed to help you keep track of the books in your school library and manage borrower records efficiently. Whether you're a student, librarian, or educator, this user-friendly Object-Oriented Programming (OOP) application simplifies the process of maintaining a well-organized library collection.
https://github.com/sahlminkok/school-library

ruby ruby-app

Last synced: 10 months ago
JSON representation

School Library is designed to help you keep track of the books in your school library and manage borrower records efficiently. Whether you're a student, librarian, or educator, this user-friendly Object-Oriented Programming (OOP) application simplifies the process of maintaining a well-organized library collection.

Awesome Lists containing this project

README

          


School Library

# 📗 Table of Contents

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

# 📖 School Library

**School Library** is designed to help you keep track of the books in your school library and manage borrower records efficiently. Whether you're a student, librarian, or educator, this user-friendly Object-Oriented Programming (OOP) application simplifies the process of maintaining a well-organized library collection.
## 🛠 Built With

### Tech Stack

Server

### Key Features

- **Add new Students or Teachers**
- **Add new Book**
- **Borrowing History**

(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 Interpreter](https://www.ruby-lang.org/en/downloads/)
- [Development Environment](https://code.visualstudio.com/download)
- RubyGems: Verify by running `gem --version`

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/sahlminkok/School-Library.git
```

### Install

Install this project with:

```sh
cd School-Project
gem install
```

### Usage

To run the project, execute the following command:

```sh
ruby name-of-file.rb
```

### Run tests

To run tests, run the following command:

```sh
bundle exec rspec
```

(back to top)

## 👥 Authors

👤 **Sahalu Aminu**

- GitHub: [@sahlminkok](https://github.com/sahlminkok)
- Twitter: [@sahlminkok](https://twitter.com/sahlminkok)
- LinkedIn: [sahlminkok](https://linkedin.com/in/sahlminkok)

(back to top)

## 🔭 Future Features

- [ ] **Add basic UI**
- [ ] **Update books**
- [ ] **Unit tests**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/sahlminkok/School-Library/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give it a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank the Microverse Community.

(back to top)

## 📝 License

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

(back to top)