Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

School-Library is a simple oop app that allows one to keep track of records of books in the library and who borrows them.
https://github.com/kessie2862/school-library

gemfile gemfile-lock ruby

Last synced: 18 days ago
JSON representation

School-Library is a simple oop app that allows one to keep track of records of books in the library and who borrows them.

Awesome Lists containing this project

README

        

# School-Library.

# 📗 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)
- [📝 License](#license)

# 📖 School-Library

**School-Library** is a simple **oop** app that allows one to keep track of records of books in the library and who borrows them.

## 🛠 Built With

### Tech Stack

Server

### Key Features

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

(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 3.2.2`
- `VSCode` or `RubyMine`

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/kessie2862/school-library.git
```

### Install

Install this project with:

```sh
cd school-library
bundle 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

👤 **Prosper Kessie**

- GitHub: [@kessie2862](https://github.com/kessie2862)
- LinkedIn: [Prosper Kessie](https://www.linkedin.com/in/prosperkessie/)

(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/kessie2862/school-library/issues).

(back to top)

## ⭐️ Show your support

If you like this project consider leaving a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse

(back to top)

## 📝 License

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

(back to top)