Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nelofarzabi/school-library

School Library is an app to record what books are in the library and who borrows them.
https://github.com/nelofarzabi/school-library

database postgresql ruby

Last synced: 26 days ago
JSON representation

School Library is an app to record what books are in the library and who borrows them.

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)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

# πŸ“– School Library

**School Library** is an app to record what books are in the library and who borrows them.

## πŸ›  Built With

### Tech Stack

Server

### Key Features

- **Add new students or teachers**.

(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](https://www.ruby-lang.org/en/documentation/installation/)

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/Nelofarzabi/school-library.git
cd school-library
```

### Install

- Confirm Ruby has been installed by running the following in the terminal:

```
ruby -v
```
### Usage

To run the project, execute the following command:

Example command:

```rb
ruby school-library.rb
```

### Run tests

No test written for this project yet!

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Nelofar Zabi**

- GitHub: [@githubhandle](https://github.com/Nelofarzabi)
- Twitter: [@twitterhandle](https://twitter.com/NelofarZabi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nelofar-zabi-1a1066213).

(back to top)

## πŸ”­ Future Features

- **Add new books**.
- **Save records of who borrowed a given book and when**.

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please give it a star⭐️

(back to top)

## πŸ™ Acknowledgments

I would like to thank Microverse to provide this project

## πŸ“ License

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


(back to top)