Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Last synced: 17 days ago
JSON representation

Host: GitHub
URL: https://github.com/strangeal/oop-school-library
Owner: Strangeal
License: mit
Created: 2022-12-19T07:45:54.000Z (almost 2 years ago)
Default Branch: dev
Last Pushed: 2023-01-04T19:09:50.000Z (almost 2 years ago)
Last Synced: 2023-03-11T22:33:24.869Z (over 1 year ago)
Language: Ruby
Size: 47.9 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

OOP School Library


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

- [💻 Getting Started](#getting-started)

    - [Setup](#setup)

    - [Prerequisites](#prerequisites)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [📝 License](#license)

# 📖 OOP School Library 

> This web app is a tool used to keep records in library for what books are in the library and who borrows them. This app allows you to:

- Add new students or teachers.

- Add new books.

- Save records of who borrowed a given book and when.

## 🛠 Built With 

### Tech Stack 

  Server

  


    Ruby

  


### Key Features 

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

- **[Add new students]**

- **[Add new books]**

- **[Save records of borrowed books]**

## 💻 Getting Started 

To get the content of this project locally you need to run the following commands in your terminal.

### Prerequisites

- IDE(code editor) like: **Vscode**, **Sublime**, etc. 

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)

### Setup

1. Download the **Zip** file or clone the repo with:

```bash

git clone [email protected]:Strangeal/OOP-school-library.git

```

3. To access cloned directory run:

```bash

cd OOP-school-library

```

3. Open it with in your terminal

```bash

ruby person.rb

```

### Install

> To install linters and other project's dependencies run:

```bash

bundle install

```

## Run Test for Linters

For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

```bash 

rubocop

```

## Authors 

👤 **Justice Bajeri**

- GitHub: [Link to Github Profile](https://github.com/Strangeal)

- Twitter: [Link to Twitter Profile](https://twitter.com/Str_angeal)

- LinkedIn: [Link to LinkedIn Profile](https://www.linkedin.com/in/justice-bajeri-0b7211243/)

## 🔭 Future Features 

- [ ] **[User interface]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

## ⭐️ Show your support 

Give a ⭐️ if you like this project!

## Acknowledgments

- Inspiration

- etc

## 📝 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._