willy836/OOP-school-library

OOP school library is a project developed using Ruby to manage a school library system. This application enables the librarian to efficiently record and manage the library's collection of books, keep track of borrowers, and maintain accurate records of borrowings.

Microverse README Template

📗 Table of Contents

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

📖 [OOP school library]

[OOP school library] is an app that can be used as a tool to add new students/ teachers, add new books, and save records of who borrowed a given book and when.

🛠 Built With Ruby

Tech Stack

• OOP in Ruby

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Add student/teacher]
• [Setup associations]
• [Preserve data]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• [Live Demo Link](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:

• Ruby installed on your computer
• gem install bundler (at terminal)

Setup

Clone this repository to your desired folder:

• git clone https://github.com/willy836/OOP-school-library.git
• cd OOP-school-library

Install

Install this project with:

• cd OOP-school-library
• gem install

Usage

To run the project, execute the following command:

• ruby [file_name] (on terminal)

Run tests

To run tests, run the following command:

• [coming soon]

Deployment

You can deploy this project using:

• netlify [coming soon]

(back to top)

👥 Author

👤 Wilson Kimiri

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Add associations]
• [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

Give this project a ⭐️ if you like it.

(back to top)

🙏 Acknowledgments

Hat tip to Microverse for the guidance and provision of Ruby learning materials

(back to top)

📝 License

This project is MIT licensed.

(back to top)