Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dennis-every/school_library

A simple school library app to demonstrate oop using ruby
https://github.com/dennis-every/school_library

Last synced: about 1 month ago
JSON representation

A simple school library app to demonstrate oop using ruby

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 School Library ](#-school-library-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 School Library

A simple school library app to demonstrate object oriented programming using Ruby

## 🛠 Built With

### Tech Stack

Ruby

### Key Features

- **Run a school library program using the command line**
- **Describe the SOLID principles of OOP.**
- **Refactor your own Ruby code after gaining new knowledge.**
- **Apply Ruby best practices and language style guides in code.**
- **Preserve data.**
- **unit tests.**

(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

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:dennis-every/school-library.git
```

### Install

No instalation needed.

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

(back to top)

## 👥 Authors

👤 **Dennis Every**

- GitHub: [@dennis-every](https://github.com/dennis-every)
- Twitter: [@dennis_every](https://twitter.com/dennis_every)
- LinkedIn: [dennis-every](https://www.linkedin.com/in/dennis-every/)

👤 **Nilton Segura**

- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/niltonsegura/)

(back to top)

## 🔭 Future Features

- **Add SQL schema to create database**

(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 feel free to fork it and use it as you need and don't forget to start it!.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for the information provided to build this project.

(back to top)

## ❓ FAQ

- **Can I use the project for any purpose?**

- Yes, you can use this files for anything you need

- **Do I need to ask for permission?**

- No need to ask for permission.

(back to top)

## 📝 License

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

(back to top)