flemton/school-library

📗 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
• 📝 License

📖 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 in a beautiful and well-organized way, this is what te school library is built to do

🛠 Built With

Tech Stack

Languages

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

• VS Code
• Ruby installed and configured.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/flemton/school-library.git

Install

Install this project with:

  bundle install

Usage

To utilize the project, you need to have Ruby installed on your computer. You can run the code by either using the IRB terminal with WSL (Windows Subsystem for Linux) or by executing the command ruby decoder.rb in your WSL terminal.

Run tests

To run tests, run the following command:

  rubocop

👥 Author

👤 Alhassan Osman

• GitHub: @flemton
• Twitter: @oalhassan847
• LinkedIn: Alhassan Osman

(back to top)

🔭 Future Features

• [Developing the UI]
• [Deploying the site]

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

(back to top)

🙏 Acknowledgments

We would like to thank microverse for allowing us to do this project

(back to top)

📝 License

This project is MIT licensed.

(back to top)