Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/danifromecuador/school_library

This project uses Ruby
https://github.com/danifromecuador/school_library

Last synced: 10 days ago
JSON representation

This project uses Ruby

Awesome Lists containing this project

README

        

# 📗 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)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 School Library

**School Library** is a Ruby project that simulates the library of a school with teachers, students, what books are and who borrows them.
## 🛠 Built With

### Tech Stack

Client

### Key Features

- **The user could add new students or teachers**
- **The user could add new books**
- **The user could add save records of who borrowed a given book and when**

(back to top)

## 🚀 Live Demo

This project doesn't have a live demo

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

Install Ruby, that depends about what OS you have:

[https://www.ruby-lang.org/en/downloads/](https://www.ruby-lang.org/en/downloads/)

Install Git:

[https://git-scm.com/downloads](https://git-scm.com/downloads)
### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:danifromecuador/school_library.git
cd school_library
```

### Usage

To run the project, execute the following command:

```sh
./main.rb
```
And start following the indications on the screen

(back to top)

## 👥 Authors

👤 **Dani Morillo**

- GitHub: [danifromecuador](https://github.com/danifromecuador)
- LinkedIn: [danifromecuador](https://www.linkedin.com/in/danifromecuador)

👤 **Pablo Bonasera**
- GitHub: [@PabloBona](https://github.com/PabloBona)
- LinkedIn: [@PabloBona](https://www.linkedin.com/in/pablo-bonasera/)

(back to top)

## 🔭 Future Features

- **The school library will use a graphic interface**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/danifromecuador/school_library/issues).

(back to top)

## ⭐️ Show your support

If you like this project give me an star on [my GitHub repo](https://github.com/danifromecuador/school_library)

(back to top)

## 🙏 Acknowledgments

I would like to thank to [The Odin Project](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby) for teaching me about Ruby

(back to top)

## 📝 License

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

(back to top)