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

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

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/inspecta/school-library
• Owner: inspecta
• License: other
• Created: 2022-12-19T11:16:52.000Z (over 3 years ago)
• Default Branch: development
• Last Pushed: 2023-01-04T17:54:40.000Z (over 3 years ago)
• Last Synced: 2025-05-16T04:37:03.809Z (about 1 year ago)
• Language: Ruby
• Size: 567 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  
School Library App 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](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 SCHOOL LIBRARY APP 

**The school library application** is an application that holds school library information. The application enables one to a new student, teacher or book and also store information of whoever borrows a book and when.

## 🛠 Built With 

### Tech Stack 

> This application is developed using these technologies

  Client

  


    
Ruby

  


  Server

  


    
N/A

  


Database

  


    
PostgreSQL

  


### Key Features 

- **Add details to the application (Book, student and teacher)**

- **Student or teacher and borrow a book**

- **Store information about the book and the person who has borrowed it**

(back to top)


## 💻 Getting Started 

> Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need a computer with the following technlogies installed:

- A text editor

- Ruby

- PostgreSQL

- Git

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone git@github.com:myaccount/my-project.git

```

### Install

Install this project with:

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author1**

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

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

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

(back to top)


## 🔭 Future Features 

- [ ] **A User Iterface design**

- [ ] **Persistance**

(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, please star it. Thanks.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for providing me with the material that I used to develop this project.

(back to top)


## ❓ FAQ 

- **Can I use this code?**

  - Yeah sure! As long as you me credit.

- **Can I contribute to this project?**

  - Yes please. Contact me and I'll add you as a contributor

  - Alternatively, feel free to leave an issue. It'll be very much appreciated

(back to top)


## 📝 License 

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

(back to top)