Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/juandbta/school-library-project

School Library is a tool to record what books are in the library and who borrows them. The app allows you to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when. And all of this is built in a beautiful and well-organized way!
https://github.com/juandbta/school-library-project

linux pair-programming rspec ruby teamwork ubuntu

Last synced: 5 days ago
JSON representation

School Library is a tool to record what books are in the library and who borrows them. The app allows you to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when. And all of this is built in a beautiful and well-organized way!

Awesome Lists containing this project

README

        



logo

# 📗 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)

# 📖 [SCHOOL LIBRARY]

**[SCHOOL LIBRARY]** is a tool to record what books are in the library and who borrows them. The app allows you to: Add new students or teachers. Add new books. Save records of who borrowed a given book and when. And all of this is built in a beautiful and well-organized way!

## 🛠 Built With

1- Ruby 3.2.2

2- Gitflow

3- Rubocop

### Tech Stack

Client

Ruby

### Key Features

- **[Added person.rb]**
- **[Added student.rb]**
- **[Added teacher.rb]**
- **[Used the "Decorator" design pattern]**
- **[Set up associations]**
- **[Added basic UI]**
- **[Refactor code]**
- **[Preserve data]**
- **[Unit tests]**

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Coming Soon...](https://github.com/JuanDBta/school-library-project)

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

Web Browser (Chrome recommended)

Code editor (VS recommended)

GitHub account

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone "https://github.com/JuanDBta/school-library-project.git"
```
### Run

Go to your /school-library-project folder:

```sh
cd school-library-project
ruby main.rb
```

### Deployment

You can deploy this project using:
[Coming Soon!!!](https://github.com/JuanDBta/school-library-project)

(back to top)

## 👥 Authors

👤 **Micronaut JUAN DAVID DIAZ**

- GitHub: [@JuanDBta](https://github.com/JuanDBta)
- Twitter: [@simplebetsas](https://twitter.com/simplebetsas)
- LinkedIn: [LinkedIn](https://linkedin.com/in/simplebet/)

👤 **Micronaut Daniel Ochuba Ugochukwu**

- GitHub: [@danielochuba](https://github.com/danielochuba)

(back to top)

## 🔭 Future Features

- [ ] **[Improve UI]**
- [ ] **[Add more menu options]**

(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

If you like this project, please give me a like, it doesn't cost you anything and it helps me a lot to keep working.

(back to top)

## 🙏 Acknowledgments

I would like to thank Bee in Student Success who is always avalaible to solve issues and Microverse for push us to work hard every day!

(back to top)

## ❓ FAQ

- **["How can I see more projects associated with these authors?"]**

- Check my [@JuanDBta](https://github.com/JuanDBta)
- Check my [@danielochuba](https://github.com/danielochuba)

- **[How can I contact the authors of this project?]**

- Check my [LinkedIn profile](https://linkedin.com/in/simplebet/) or email me at [email protected]
- Email me at [email protected]

(back to top)

## 📝 License

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

(back to top)