School Library

School Library is a console app that allows users to: add new students or teachers, add new books, save records of who borrowed a given book and when. Built with Ruby.

📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 School Library

School Library is a tool that allows a user to record what books are in the library and who borrows them.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

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:

• GitHub account;
• Git installed on your OS;
• VSCode (or another code editor);
• Ruby installed;

Setup

Clone this repository to your desired folder:

Login to your GitHub account. Clone this repository to your desired folder:

cd my-folder git clone [email protected]:Zilola-Nazarova/school-library.git

Install

Install this project with: (will be added in following projects)

Usage

To run the project, execute the following command: (will be added in following projects)

Run tests

To run tests, run the following command: (will be added in following projects)

You can also check linter errors by running these commands:

rubocop

(back to top)

👥 Authors

👤 Zilola Nazarova

• GitHub: @Zilola-Nazarova
• Twitter: @NazarovaZi
• LinkedIn: in/NazarovaZi

👤 Suleiman Gacheru

• GitHub: @hetrox8
• Twitter: @suleimangacheru
• LinkedIn: in/suleiman-yusuf-gacheru

(back to top)

🔭 Future Features

• use the "Decorator" design pattern
• set up associations
• add basic UI
• preserve data
• add 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 just star it!

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse program for the knowledge and skills I have acquired in Modules 1-3.

I am grateful to all previous project reviewers for their advice. Thanks to them I could build this app.

(back to top)

❓ FAQ (OPTIONAL)

• Why is there no Live Demo link?

  • This is a student project and the Live Demo will be added after reaching the corresponding phase of the project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)