Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/grandi0z/school_library

The School Library App is a tool that helps the librarian to keep track of the books and the people who borrow them
https://github.com/grandi0z/school_library

Last synced: about 1 month ago
JSON representation

The School Library App is a tool that helps the librarian to keep track of the books and the people who borrow them

Host: GitHub
URL: https://github.com/grandi0z/school_library
Owner: Grandi0z
License: mit
Created: 2023-09-13T09:56:36.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-09-17T00:15:46.000Z (over 1 year ago)
Last Synced: 2024-05-17T15:25:46.643Z (8 months ago)
Language: Ruby
Size: 67.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

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)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 School Library 

**School Library** is a tool that helps the librarian to keep track of the books and the people who borrow them.  

With this app, you can:

- Add new students or teachers to the library database, with their name, ID, and contact information.

- Add new books to the library inventory, with their title, author, genre, and ISBN number.

Save records of who borrowed a given book and when, with the option to mark the book as returned or overdue.

- Search for books or borrowers using various criteria, such as name, genre, or ID.

## 🛠 Built With 

### Tech Stack 

  

    


      Ruby

    

  

(back to top)


### Key Features 

- **Manage Books**

- **Add new students or teachers**

- **Record the data of the person who borrows the books**

## Getting Started

### Prerequisites

In order to run this project, you must have installed and configured ruby in your local environment:

### Setup

Clone this repository to your desired folder:

Before to run the program, verify that you have Ruby installed on your OS running the following command:

### Usage

Run the following command inside the project folder:

1. Open your terminal and navigate to the root directory of your project.

2. Open the `lib` directory ```$ cd lib```

3. Run ```$ ruby main.rb```

4. Enjoy

(back to top)


### Run tests

You can run this tests

```$

  rubocop

```

### Deployment

You can deploy this project using: GitHub Pages Netifly or Render 

(back to top)


## 👥 Authors 

👤 **Joseph L Kausi**

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

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

- LinkedIn: [Joseph L Kausi](https://www.linkedin.com/in/joskal/)

(back to top)


## 🔭 Future Features 

- [ ] **Store data in a database**

- [ ] **Add a UI**

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project, I would like to Thank You!

(back to top)


## 🙏 Acknowledgments 

Special Thanks to the Microverse and Micronauts.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/Grandi0z/school_library/blob/build/LICENSE) licensed.

(back to top)