https://github.com/timbar09/school_library-ruby
This is a user-friendly tool that efficiently manages book inventory, borrowers, and borrowing history, providing accurate record keeping and enhancing the borrower experience.
https://github.com/timbar09/school_library-ruby
command-line-app gitflow-workflow pair-programming pry rspec ruby
Last synced: 15 days ago
JSON representation
This is a user-friendly tool that efficiently manages book inventory, borrowers, and borrowing history, providing accurate record keeping and enhancing the borrower experience.
- Host: GitHub
- URL: https://github.com/timbar09/school_library-ruby
- Owner: Timbar09
- License: mit
- Created: 2023-04-10T11:09:34.000Z (about 3 years ago)
- Default Branch: development
- Last Pushed: 2023-04-19T15:02:13.000Z (about 3 years ago)
- Last Synced: 2025-03-29T11:13:25.807Z (about 1 year ago)
- Topics: command-line-app, gitflow-workflow, pair-programming, pry, rspec, ruby
- Language: Ruby
- Homepage:
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# School_Library-Ruby
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
This is a user-friendly tool that efficiently manages book inventory, borrowers, and borrowing history, providing accurate record keeping and enhancing the borrower experience.
Client
- **Student and Teacher Management**
> Allows users to add new students or teachers to the library. Users will be able to input relevant information such as names, contact details, and identification numbers for easy identification and communication.
- **Book Management**
> Users can input details such as book title and author to create a comprehensive collection of available books.
- **Borrowing and Return Records**
> The app efficiently records who borrowed a particular book and when. It creates borrower profiles and link them to specific books that borrowers borrow. It also tracks the due dates for book returns.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- To install [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/Timbar09/School_Library-Ruby.git
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
To run tests, run the following command:
```sh
rspec ./spec/[name of test-file]
```
For example:
```sh
rspec ./spec/teacher_spec.rb
```
| 👤 Author | GitHub | Twitter | LinkedIn |
| :-- | :-- | :-- | :-- |
| Miles Mosweu | [@Timbar09](https://github.com/Timbar09) | [@Milez09](https://twitter.com/Milez09) | [@miles-mosweu09](https://www.linkedin.com/in/miles-mosweu09) |
| Fitz Gerald | [@fitz95](https://github.com/fitz95) | [@nsonggerald](https://twitter.com/nsonggerald) | [@nsong-asoh](https://www.linkedin.com/in/nsong-asoh) |
- [ ] **Add extra functionality to the app.**
- [ ] **Improve the app UI.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Timbar09/School_Library-Ruby/issues).
If you like this project, give it a ⭐️ and let me know what you like in particular.
I would like to thank the microverse community for the useful content.
This project is [MIT](./LICENSE) licensed.