Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/indiecodermm/oop-school-library

School library console app using OOP concepts
https://github.com/indiecodermm/oop-school-library

Last synced: 8 days ago
JSON representation

School library console app using OOP concepts

Awesome Lists containing this project

README

        

## 📗 Table of Contents

- [📚 OOP School Library](#-oop-school-library)
- [🛠 Built With](#-built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Installation](#installation)
- [Usage](#usage)
- [👥 Authors](#-authors)
- [🔭 Future Features](#-future-features)
- [🤝 Contributing](#-contributing)
- [💖 Show your support](#-show-your-support)
- [🙏 Acknowledgments](#-acknowledgments)
- [📜 License](#-license)

# 📚 OOP School Library

A simple console app that allows users to create student and teacher objects, add new books to the library and keep track of borrowing records.

## 🛠 Built With

### Tech Stack

- Ruby

### Key Features

- Add new students or teachers
- Add new books
- Save borrowing records

(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](https://www.ruby-lang.org/en/) installed on your machine.

### Setup

Clone this repository to your desired folder:

```sh
cd my-project
git clone [email protected]:IndieCoderMM/oop-school-library.git .
```

### Installation

Install this project with:

```sh
gem install
```

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

(back to top)

## 👥 Authors

👨‍🚀 **Hein Thant**

- GitHub: [@githubhandle](https://github.com/indiecodermm)
- LinkedIn: [LinkedIn](https://linkedin.com/in/hthantoo)
- Gmail: [email protected]

👨‍🚀 **Yetemegn Lemma**

- GitHub: [@yetemegn-telaye](https://github.com/yetemegn-telaye)
- Twitter: [@Yetemegn19](https://twitter.com/Yetemegn19)
- Gmail: [email protected]

👨‍🚀 **Ajayi Ridwan**

- GitHub: [@Ridwanullahi-code](https://github.com/Ridwanullahi-code)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ajayi-ridwan/)

(back to top)

## 🔭 Future Features

- [ ] Add basic UI
- [ ] Preserve data
- [ ] Unit tests

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## 💖 Show your support

If you like this project, please consider giving it a ⭐.

(back to top)

## 🙏 Acknowledgments

I would like to thank all code reviewers for making this project better.

(back to top)

## 📜 License

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

(back to top)