Diegogagan2587/school-library

Object Oriented Programming School Library app is a tool create record for books in a library and for who borrows them, cretated with Ruby

README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests

• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 School Library

What is School Library?

School Library is a tool for creating records about books in a library and for keep track of who borrows them as well, created with ruby based on Object Oriented Programming design.

🛠 Built With

Tech Stack

Do you want to know more about the Technologies used in this project?

Client

• Ruby

Key Features

take a look for key features below:

• Include person.rb file with person class
• Include a student.rb file with a Student class
• Include a teacher.rb file with a teacher class

(back to top)

💻 Getting Started

Do you want to know more about how to use this project?

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

Prerequisites

In order to run this project you need:

• Ruby installed in your computer

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Diegogagan2587/school-library.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, make sure you are within src folder on your terminal, then call the app like this:

  ruby main.rb

Run tests

So far you can only check for linters test with the next command:

  rubocop

make sure you are in the root folder.

(back to top)

-->

👥 Authors

Do you want to know more about author?

👤 Diego Vidal

• GitHub: @Diegogagan2587
• Twitter: @dieg02587
• LinkedIn: diego-vidal-lopez

(back to top)

🔭 Future Features

We are planning to add the next features soon:

• Basic UI
• Unit Test
• Add new students or teachers
• Add new books
• Save records of who borrowed a given book and when

(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 please leave and start or make a suggestion in the issues page.

(back to top)

🙏 Acknowledgments

I would like to thank to Microverse for suggesting this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)