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

https://github.com/prangonghose/school-libray-with-ruby

It is a repository holding Ruby codes to display terminal UI in order to fully run a School Library app.
https://github.com/prangonghose/school-libray-with-ruby

ruby

Last synced: over 1 year ago
JSON representation

It is a repository holding Ruby codes to display terminal UI in order to fully run a School Library app.

Awesome Lists containing this project

README

          

logo

School Library with Ruby

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [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)

# πŸ“– Project Name

## School Library with Ruby

## πŸ›  Built With

- `Ruby`

### Key Features

> Describe between 1-3 key features of the application.

- A simple code to add persons in a School Library in Ruby.

(back to top)

## πŸš€ Live Demo

Live demo is currently unavailable.

(back to top)

## πŸ’» Getting Started
To clone the repository in local environment try following steps.

### Prerequisites

- [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```

Likewise for Node.js and npm for package installation.
```
$ ruby --version && gem --version
```
### Setup

Clone the repository using [this link](https://github.com/PrangonGhose/school-library-with-ruby.git).

### Install

In the terminal, go to your file directory and run this command.

```
$ git clone https://github.com/PrangonGhose/school-library-with-ruby.git
```
### Get into development

In the terminal, run these commands to get into development.
```
$ cd school-library-with-ruby

$ bundle init

$ bundle install (install dependencies)

$ ruby main.rb (run the app locally)
```
### Usage

This website is applicable for both mobile and desktop version.

### Deployment

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Prangon Ghose**

- GitHub: [@PrangonGhose](https://github.com/PrangonGhose)
- LinkedIn: [Prangon Ghose](https://www.linkedin.com/in/prangon-ghose/)

πŸ‘€ **Ricardo MartΓ­nez**

- GitHub: [@rmrmrmr](https://github.com/rmrmrmr)
- Twitter: [@ricmtza](https://twitter.com/ricmtza)
- LinkedIn: [LinkedIn](www.linkedin.com/in/ricardo-mag)

(back to top)

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the [issues page](https://github.com/PrangonGhose/school-library-with-ruby/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## πŸ™ Acknowledgments

Authors would like to thank:
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners

(back to top)

## πŸ“ License

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