https://github.com/devmunyi/oop_school_library
This project is a practice exercise that entails building OOP library to manage books recording and borrowing.
https://github.com/devmunyi/oop_school_library
Last synced: about 1 year ago
JSON representation
This project is a practice exercise that entails building OOP library to manage books recording and borrowing.
- Host: GitHub
- URL: https://github.com/devmunyi/oop_school_library
- Owner: devMunyi
- License: mit
- Created: 2022-12-19T10:20:31.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-04T19:00:45.000Z (over 3 years ago)
- Last Synced: 2025-01-09T18:57:46.993Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [💻 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](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
> This project is a practice exercise that entails building OOP library to manage recording and borrowing of books.
Client
**You can do the following with app:**
- Add new students or teachers.
- Add new books.
- Save records of who borrowed a given book and when.
- Persist the data in a json file.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/devMunyi/OOP_school_library.git
```
- Navigate to the location of the folder in your machine:
**`you@your-Pc-name:~$ cd OOP_school_library`**
### Install
To install all dependencies, run:
```
bundle install
```
### Usage
To run the project, follow these instructions:
- After Cloning this repo to your local machine.
- To get it running in your terminal, run it in your IDE
### Run tests
To run tests, run the following command:
```
rubocop
```
👤 **Samuel Munyi**
- GitHub: [@devMunyi](https://github.com/devMunyi)
- LinkedIn: [Samuel Munyi](https://www.linkedin.com/in/samuel-munyi-01315b174/)
👤 **Ndikumana Isaie**
- GitHub: [ndikumanaisaie](https://github.com/ndikumanaisaie)
- Twitter: [Ndikuma38670724](https://twitter.com/Ndikuma38670724)
- LinkedIn: [Ndikumana Isaie](https://www.linkedin.com/in/ndikumanaisaie/)
👤 **Derrick Mulinde**
- GitHub: [inspecta](https://github.com/inspecta)
- Twitter: [djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [Derrick Mulinde](https://www.linkedin.com/in/derrick-mulinde/)
- [ ] **Implement more methods.**
- [ ] **Write Extra Message.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project and how I managed to build it!
- The original design ideal from Microverse💕.
- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby / Database and Interviewing module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.
- **Can I fork and reuse the repository**
- Yes please, feel free.
- **Can I improve the repository, and my changes will be accepted if they are good?**
- Yes please, nice ideas are welcome, please.
This project is [MIT](./LICENSE) licensed.