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

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

is a console application built with Ruby that used to manage a school library. It allows to record what books are in the library and who borrows them.
https://github.com/degisew/school-library

ruby

Last synced: about 1 year ago
JSON representation

is a console application built with Ruby that used to manage a school library. It allows to record what books are in the library and who borrows them.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 school-library

**[school-library]** is a console application built with Ruby that used to manage a school library. It allows to record what books are in the library and who borrows them.

## 🛠 Built With

- Ruby
-Rubocop Linters

### Tech Stack

Programming language

### Key Features

- **[Add new students or teachers]**
- **[Add new books]**
- **[Save records of who borrowed a given book and when]**

(back to top)

## 🚀 Live Demo

Not available.

(back to top)

## 💻 Getting Started

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

### Prerequisites

To run this project you need to have installed [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and a code editor, we are using [Visual Studio Code](https://code.visualstudio.com/download) with Code runner extension, this is a [video](https://www.youtube.com/watch?v=bDSIzatb1N4) explaining how to configure Code runner.

### Setup

Clone this repository to your desired folder:
Example commands:

```sh
cd school-library
git clone https://github.com/degisew/school-library.git
```

### Usage

To run the project, add a parameter to decoding-message function, separating each word with 3 spaces and each letter using 1 space and then right-click on the text editor to run with the Code runner extension.

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Degisew**

- Location: Ethiopia
- GitHub: [@jegisew21](https://github.com/degisew)
- Twitter: [@DJ_etiya](https://twitter.com/@DJ_etiya)
- LinkedIn: [jegisew21](https://www.linkedin.com/in/degisew-mengist)

👤 **Suleiman Olaade**

- Location: Nigeria
- GitHub: [@Ceemos96](https://github.com/Ceemos96)
- Twitter: [@Ceemos_dev](https://twitter.com/Ceemos_dev)
- LinkedIn: [suleiman-olaide](https://www.linkedin.com/in/suleiman-olaide)

(back to top)

## 🔭 Future Features

- [ ] **[A Graphical User Interface]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/degisew/school-library/issues).

(back to top)

## ⭐️ Show your support

If you like this project give this repo a star and reach out on our social media, and we will be happy to know about it! 😃

(back to top)

## 🙏 Acknowledgments

would like to thank the Microverse team and my coding partners.

(back to top)

## ❓ FAQ

- **How can I contribute?**

- Please send us a message on our social media and we will let you contribute.

- **What if I have problems running this project?**

- Let us know on our social media DMs, we will be happy to help you.

(back to top)

## 📝 License

This project is [MIT](https://github.com/degisew/school-library/blob/dev/LICENSE) licensed.

(back to top)