Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/oop-school-lib

oop-school-lib-prac Is an app a Librarian at a school university uses to create new user (students/teachers), add new books, and save records of who borrowed a given book and when.
https://github.com/stephenkati/oop-school-lib

oop postgresql rspec-testing ruby

Last synced: 23 days ago
JSON representation

oop-school-lib-prac Is an app a Librarian at a school university uses to create new user (students/teachers), add new books, and save records of who borrowed a given book and when.

Awesome Lists containing this project

README

        

# oop-school-lib

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

# 📖 [oop-school-lib]

**[oop-school-lib]** Is an app a Librarian at a school university uses to create new user (students/teachers), add new books, and save records of who borrowed a given book and when.

## 🛠 Built With

### Tech Stack

Ruby

### Key Features

- **[Class functionality]**

(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:

```sh
bundle install
```

### Setup

Clone this repository to your desired folder:

```sh
cd oop-school-lib
git clone https://github.com/stephenkati/oop-school-lib.git
```

### Install

Install this project with:

```sh
cd oop-school-lib
bundle install
gem install --no-document rubocop -v '>= 1.0, < 2.0'
gem install rspec
```

### Usage

To run the project, execute the following command:

- `ruby main.rb`
or
- `./main`

### Run tests

To run tests, run the following command:

- `rubocop --color`
- `rspec spec --format doc`

### Deployment

- N/A

(back to top)

## 👥 Authors

👤 **STEPHEN KATULI**

- GitHub: [@ehmaddd](https://github.com/ehmaddd/)
- LinkedIn: [@ehmaddd](https://www.linkedin.com/in/ehmaddd/)
- Twitter: [@ehmaddd_pk](https://twitter.com/ehmaddd_pk)

👤 **AHMAD SAEED**

- GitHub: [@githubhandle](https://github.com/stephenkati)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)

## 🔭 Future Features

- [ ] **[Add different structure]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/stephenkati/oop-school-lib/issues).

(back to top)

## ⭐️ Show your support

If you like this project please show support by staring ⭐️.

(back to top)

## 🙏 Acknowledgments

* I would like to thank Microverse for accommodating us in the Full-time Software Development program.

(back to top)

## 📝 License

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

(back to top)