School Library

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 School Library

School Library is a Ruby console application for managing a library of a school. The application leverages Object Oriented Programming (OOP) and its classes to create manageable objects like students, teachers, classroom etc.

🛠 Built With

• Ruby

Tech Stack

Key Features

• [This project has a Person class with name, age, etc properties that serves as a super class for Student and Teacher classes]
• [This project has a Student class that inherits from Person class]
• [This project has a Teacher class that inherits from Person class]
• [This project uses Gitflow] [Refactor code to follow SOLID principles]
• [Preserve data in json files]

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

• git: A tool for managing source code

• Visual Studio Code: A source code editor

Setup

• Clone this repository to your desired folder: https://github.com/frempongdev/OOP-school-library.git
• Run bundle install to install the dependencies.

Install

Install this project with:

• cd school-library
• ubuntu version 22 or higher

Usage

To run the project, execute the following command:

• ruby person.rb
• ruby student.rb
• ruby teacher.rb

Run tests

To run tests, run the following command:

• Run robocop .

Deployment

You can deploy this project using:

• Github pages

Github pages

follow these steps for example

👥 Author

👤 Frempong

• GitHub: @frempongdev
• Twitter: @knobaddy
• LinkedIn: Samuel knower Amankwaa-Frempong

👤 Jonas Nuta Wallah

• GitHub: @Jonas-45
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Classromm Class implementation]
• [Book Class implementation]
• [Console app navigation and functionalities]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

• Give a ⭐️ if you like this project and kindly support by suggesting changes by forking and pull requests.

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the resources and the platform for me to be a Professional full-stack developer.

(back to top)

📝 License

This project is MIT licensed.

(back to top)