uisendy/ruby_school_library

School library is a fully OOP library managment system built using ruby as a console application. The user has the ability to add books, persons and create rentals for specific books.

📗 Table of Contents

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

📖 school-library_OOP

school-library_OOP School library is a fully OOP library management system built using ruby as a console application. The user has the ability to add books, persons and create rentals for specific books.

🛠 Built With

Tech Stack

Backend

• Ruby

Key Features

This library app has following objects.

• [Person]
• [Student]
• [Teacher]
• [Book]
• [Classroom]
• [Nameable]

(back to top)

🚀 Live Demo

• Coming soon

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

• A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
• Ruby installed on the Computer

Setup

Clone this repository to your desired folder:

• git clone https://github.com/uisendy/ruby_school_library.git if your're using https or git
• git@github.com:uisendy/ruby_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)

👥 Author

I was the sole collaborator in this project.

👤 Sendy Inieke

• GitHub: @uisendy
• LinkedIn: sendyinieke

(back to top)

🔭 Future Features

• [UNIT TESTS]
• [PRESERVE DATA]
• [REFACTOR CODE]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project then kindly give me a star ⭐️ in the project repository.

(back to top)

🙏 Acknowledgments & Attribution

• I would like to thank Microverse.
• Hat tip to anyone whose code was used
• Inspiration
• etc

(back to top)

📝 License

This project is MIT licensed.

(back to top)