https://github.com/nkaleth/school_library

In this project, I will start building a school library app.
https://github.com/nkaleth/school_library

Last synced: 5 days ago
JSON representation

In this project, I will start building a school library app.

• Host: GitHub
• URL: https://github.com/nkaleth/school_library
• Owner: Nkaleth
• Created: 2023-04-10T22:23:21.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-04-14T17:43:18.000Z (over 1 year ago)
• Last Synced: 2024-10-16T07:51:51.554Z (30 days ago)
• Language: Ruby
• Size: 575 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# 📗 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](#deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ ](#faq)

- [📝 License](#license)

# 📖 School Library 

**School Library** is a Ruby based software to record what books are in a School library and who borrows them.

## 🛠 Built With 

### Tech Stack 

Ruby

  


    
PostgreSQL

  


### Key Features 

- **Add new students or teachers.**

- **Add new books.**

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

- **use the "Decorator" design pattern.**

- **set up associations.**

- **add basic UI.**

(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

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:Nkaleth/school_library.git

  cd school_library

```

### Install

No need instalation.

### Usage

To run the project, execute the following command:

```sh

  ruby main.rb

```

(back to top)


## 👥 Author 

👤 **Nilton Segura**

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

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

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

(back to top)


## 🔭 Future Features 

- **refactor the code.**

- **preserve data.**

- **unit tests.**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project feel free to fork it and use it as you need and don't forget to start it!.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ 

- **Can I use the project for any purpose?**

  - Yes, you can use this files for anything you need

- **Do I need to ask for permission?**

  - No need to ask for permission.

(back to top)


## 📝 License 

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

(back to top)