Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/joramot/oop_school_library


https://github.com/joramot/oop_school_library

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README

        

# oop_school_library

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [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)

# 📖 School library

One school library app to record what books are in the library and who borrows them.

## 🛠 Built With

### Tech Stack
- Ruby

Client

(back to top)

### Key Features

- Stores books and rentals.

(back to top)

## 💻 Getting Started

To get a local copy up and running follow these simple example steps.
### Setup

To run the project execute the command below
`ruby person.rb`

### Setup

Clone this repository to your desired folder:

```sh
cd my-prefered-folder
git clone [email protected]:joramot/oop_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 main.rb
```

### Run tests

To run tests, run the following command:

```sh
rspec spec/
```
...

## 👥 Author

👤 **Jose RM**

- GitHub: [@Joramot](https://github.com/joramot)
- Twitter: [@El_rulis](https://twitter.com/el_rulis)
- LinkedIn: [jose-RM](https://linkedin.com/in/jose-RM)

## 🔭 Future Features

- Stay tuned for future updates.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/joramot/oop_school_library/issues).

(back to top)

## ⭐️ Show your support

If you like this project don't doubt on make any comments or try to reach me out.

(back to top)

## 🙏 Acknowledgments

- Thanks to Microverse and and to the code reviewers who supported me to improve my code.

(back to top)

## 📝 License

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

(back to top)