Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sonickmumba/oop-school-library


https://github.com/sonickmumba/oop-school-library

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

logo

Microverse README Template

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [OOP School Library]

**[OOP School Library]** is a tool that allows a librarian in a University to record what books are in the library and who borrows them. This app will allow the librarian to add new students or teachers, add new books and save records of who borrowd a given book and when.

## 🛠 Built With Ruby

## 🚀 Live Demo

> Add a link to your deployed project.

- [Live Demo Link](https://yourdeployedapplicationlink.com)

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:Sonickmumba/OOP-School-library.git


```

### Install

Install this project with:

```sh
cd OOP-school-library
gem install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Author1**

- GitHub: [@Sonickmumba](https://github.com/Sonickmumba/)
- Twitter: [@sonickmumba](https://twitter.com/sonickmumba)
- LinkedIn: [Sonick mumba](https://linkedin.com/in/sonickmumba)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank...
- **Microverse** for giving this opportunity to learn
- Code reviewers & coding Partners
- Hat tip to anyone whose code was used
- Inspiration

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)