https://github.com/blase147/oop-school-library

This is a school library app. In this project, I implement the classes to represent students and teachers.
https://github.com/blase147/oop-school-library

association-rules classes methods objects ruby ui

Last synced: 6 months ago
JSON representation

This is a school library app. In this project, I implement the classes to represent students and teachers.

• Host: GitHub
• URL: https://github.com/blase147/oop-school-library
• Owner: blase147
• License: mit
• Created: 2023-01-08T13:53:44.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-21T07:04:07.000Z (over 2 years ago)
• Last Synced: 2025-02-03T02:32:51.616Z (8 months ago)
• Topics: association-rules, classes, methods, objects, ruby, ui
• Language: Ruby
• Homepage:
• Size: 68.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

- [📖 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)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [❓ FAQ (OPTIONAL)](#faq)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

## 📖 OOP-School-Library

This APP will allow you to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when. And all of this is done in a beautiful and well-organized way!

## 🛠 Built With 

### Tech Stack 

Backend

  


    
Ruby

  


### Key Features 

- **Add new students or teachers**

- **Add new books**

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

- **Include Unit tests for TDD compliance**

(back to top)


## 🚀 Live Demo 

- [Coming soon...](https://github.com/blase147/OOP-School-Library.io)

(back to top)


## 💻 Getting Started 

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

- copy this link 

- get the directory that you want to clone the repository.

### Prerequisites

In order to run this project you need:

- A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.

- Ruby installed on the Computer

### Setup

open the command prompt in this directory.

- write git clone 

- or git clone git@github.com/blase147/OOP-School-Library.git` if you prefer ssh and hit enter.

- create a directory in your preferred location (e.g in the Desktop or Document directory)

### Install

Install this project with:

- Dependencies _(a packet manager is required)_: then you run the command `npm install` in the terminal

### Usage

To run the project, execute the following command:

- `ruby -the name of the file-`

- This will run the project in the terminal in the specified directory

### Run tests

To run tests, run the following command:

- `npm run test`

- This will run all tests on your local machine

(back to top)


## 👥 Authors 

👤 **Chukwuma Paul Mosanya**

[GitHub](https://github.com/blase147) | [Twitter](https://twitter.com/ChukwumaMosanya) | [LinkedIn](https://www.linkedin.com/in/chukwuma-mosanya)

👤 **Oluwatoyin Olaoye**

- GitHub: [![Abayomi](https://img.shields.io/badge/-Abayomi-white?logo=GitHub&logoColor=181717&style=plastic)](https://github.com/abayomiolaoye)

- Twitter: [![Abayomi](https://img.shields.io/badge/-Abayomi-blue?logo=Twitter&logoColor=skyBlue&style=plastic)](https://twitter.com/olaoyeelijah)

- LinkedIn: [![Oluwatoyin](https://img.shields.io/badge/-Oluwatoyin-white?logo=LinkedIn&logoColor=181717&style=plastic)](https://linkedin.com/in/oluwatoyinolaoye)

👤 **Sammuel LEKPOR**

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

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

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

(back to top)


## 🔭 Future Features 

> To be added later

(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 😄, a star would be a nice gift from you :astronaut:

(back to top)


## 🙏 Acknowledgments 

A big thanks to the [Microverse Team](https://www.microverse.org)

(back to top)


## 📝 License 

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

(back to top)