https://github.com/abdelaziz-mahdi/school-library

School library app
https://github.com/abdelaziz-mahdi/school-library

Last synced: 28 days ago
JSON representation

School library app

• Host: GitHub
• URL: https://github.com/abdelaziz-mahdi/school-library
• Owner: Abdelaziz-Mahdi
• License: mit
• Created: 2023-08-28T20:57:43.000Z (about 1 year ago)
• Default Branch: develop
• Last Pushed: 2023-09-03T03:24:02.000Z (about 1 year ago)
• Last Synced: 2024-05-17T15:35:58.562Z (6 months ago)
• Language: Ruby
• Size: 28.3 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  School Library



# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Clone](#clone)

  - [Usage](#usage)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

- [⭐️ Future Features](#future-features)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 School Library 

**School Library** Is an OOP Ruby App that has a tool to record what books are in the library and who borrows them.

## 🛠 Built With 

### Tech Stack 

Languge

  


    
Ruby

  


### Key Features 

- Add new students or teachers.

- Add new books.

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

(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:

Download and Install the latest Ruby distributions.

[Download Ruby](https://www.ruby-lang.org/en/downloads/)

### Setup

- *Docs*

[Installation Documentation](https://www.ruby-lang.org/en/documentation/installation/)

### Clone

- Clone this repo to your local machine using `https://github.com/Abdelaziz-Mahdi/school-library.git`

### Usage

Using cl in the project directory:

- irb.

- For Person class:

  - require './src/person.rb'.

  - Add new person by using Person.new(name, age, parent_permission).

- For Student class:

  - require './src/student.rb'.

  - Add new student by using Student.new(name, age, parent_permission).

- For Teacher class:

  - require './src/teacher.rb'.

  - Add new teacher by using: Teacher.new(name, age, specialization).

(back to top)


## 👥 Authors 

👤 **Abdelaziz Mahdi**

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

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

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

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Abdelaziz-Mahdi/clinic-db/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## ⭐️ Future Feature 

- [X] Project 1: add Person, Student, and Teacher classes.

- [X] Project 2: use the "Decorator" design pattern.

- [X] Project 3: set up associations.

- [X] Project 4: add basic UI.

- [ ] Project 5: refactor your code.

- [ ] Project 6: preserve data.

- [ ] Project 7: unit tests.

(back to top)


## 🙏 Acknowledgments 

- Project inspired by Microverse Program.

(back to top)


## 📝 License 

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

(back to top)