📗 Table of Contents

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

📖 [School Library]

[School Library] Imagine that you are the librarian of OOP University, and you need a tool to record what books are in the library and who borrows them.

🛠 Built With

Tech Stack

Client

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

• Install Ruby

Setup

Clone this repository to your desired folder:

Example commands:

  cd school-library
  git clone git@github.com:evillaz/school-library.git

Install

Run this command:

Example command:

  cd school-library
  npm bundle install

To install dependencies and use rubocop

Usage

Run this command:

• Start Ruby ird
• Run ruby main.rb

Run tests

Example command:

  cd spec
rspec *spec.rb

Deployment

You can deploy this project using:

Visual studio code or with the very own ruby ird

(back to top)

👥 Authors

👤 Eduardo Villarreal

• GitHub: @evillaz
• Twitter: @evillazz
• LinkedIn: LinkedIn

👤 Matee Safi

• GitHub: @matee-safi
• Twitter: @matee_safi
• LinkedIn: Matee Safi

🔭 Future Features

• [Use the "Decorator" design pattern.]
• [Set up associations.]
• [Add basic UI.]
• [Refactor your code.]
• [Preserve data.]
• [Unit tests.]

(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 don't doubt on make any comments or try to reach me out.

(back to top)

🙏 Acknowledgments

I would like to thank microverse for the opportunity on working each other as colleagues and the learning opportunities it brings us.

(back to top)

❓ FAQ (OPTIONAL)

• Did you find hard to create this project?

  • I tried my best and follow the guidelines to create this project. I got hard times on some of the workflow but i think i just have to keep learning everyday and give my best try every time.

• What was your thinking process to solve the requirements?

  • First i tried to address each one of the requirements and solve them individually to keep integrating them as i was progressing.

(back to top)

📝 License

This project is MIT licensed.

(back to top)