Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrianarivo/oop_school_library

OOP School Library is a tool to record what books are in the library and who borrows them.
https://github.com/andrianarivo/oop_school_library

Last synced: about 17 hours ago
JSON representation

OOP School Library is a tool to record what books are in the library and who borrows them.

Host: GitHub
URL: https://github.com/andrianarivo/oop_school_library
Owner: andrianarivo
Created: 2023-07-24T12:57:22.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-02T18:02:17.000Z (over 1 year ago)
Last Synced: 2024-04-28T08:02:30.915Z (10 months ago)
Language: Ruby
Homepage:
Size: 59.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



OOP 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)

# 📖 OOP School Library 

**OOP School Library** is a  a tool to record what books are in the library and who borrows them.

## 🛠 Built With 

### Tech Stack 

  Server

  


    Ruby

  


### 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`

- `PostgreSQL`

- `VSCode` or `RubyMine`

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/andrianarivo/oop_school_library.git

```

### Install

Install this project with:

```sh

  cd oop_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

  bundle exec spec

```

(back to top)


## 👥 Authors 

👤 **David**

- GitHub: [@andrianarivo](https://github.com/andrianarivo)

- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)

- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)

(back to top)


## 🔭 Future Features 

- [ ] **add basic UI**

- [ ] **preserve data**

- [ ] **unit tests**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project consider adding a ⭐️

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse

(back to top)


## 📝 License 

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

(back to top)