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

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

Application built in ruby to track all the information about a borrowed book, register user, professor or student, add books and borrowed books
https://github.com/d4nqw3rty/oop-school-library

ruby sql

Last synced: over 1 year ago
JSON representation

Application built in ruby to track all the information about a borrowed book, register user, professor or student, add books and borrowed books

Awesome Lists containing this project

README

          



logo

Microverse README Template

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» 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)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– [OOP school library]

>

**[OOP school library]** is an app that record what books are in the library and who borrows them.

## πŸ›  Built With

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Ruby

### Key Features

>

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

(back to top)

## πŸš€ Live Demo

>
- [Not available]()

(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:
- Install Ruby in your computer [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
- Install Git in your computer [Git](https://git-scm.com/downloads)
- Any text editor [VSCode](https://code.visualstudio.com/download) recomended

### Setup

Clone this repository to your desired folder:

git clone git@github.com:d4nQw3rty/OOP-school-library.git

### Install

Install this project with:

run in your terminal the command: bundle install

### Usage

To run the project, execute the following command:

exeecute the command: ruby main.rb

### Run tests

To run tests, run the following command:

### Deployment

You can deploy this project using:

(back to top)

## πŸ‘₯ Authors

> Mention all of the collaborators of this project.

πŸ‘€ **Danys Linares**

- GitHub: [@github](https://github.com/d4nQw3rty)
- Twitter: [@twitter](https://twitter.com/Danys_Linares)
- LinkedIn: [LinkedIn](www.linkedin.com/in/danys-linares)

πŸ‘€ **Oscar FernΓ‘ndez MuΓ±oz**

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

(back to top)

## πŸ”­ Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **[Calculate any fee]**
- [ ] **[add book quantity]**
- [ ] **[How many are borrow]**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/d4nQw3rty/OOP-school-library/issues).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project give a star ⭐️

(back to top)

## πŸ™ Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank [Microverse](https://www.microverse.org/) for the opportunity to learn and grow as a developer.

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Was it built with ruby?]**

- [yes it was]

- **[will you create new programs?]**

- [Yes i will be creating new programs]

(back to top)

## πŸ“ License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)