https://github.com/kelvin-ben/oop-school-library

OOP school library: add Person, Student and Teacher classes
https://github.com/kelvin-ben/oop-school-library

Last synced: 2 days ago
JSON representation

OOP school library: add Person, Student and Teacher classes

• Host: GitHub
• URL: https://github.com/kelvin-ben/oop-school-library
• Owner: Kelvin-Ben
• Created: 2022-12-20T15:41:35.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-24T16:16:54.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T00:56:04.430Z (over 1 year ago)
• Language: Ruby
• Size: 566 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  

  


  
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 (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [OOP school library] 

**add Person, Student and Teacher classes** is a school library app. In this initial stage, I will implement classes to represent students and teachers. 

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

  


  Server

  


    
Ruby

  


Database

  


    
PostgreSQL

  


### Key Features 

> As a Librarian, and you need a tool to record what books are in the library and who borrows them. The app will allow you to: 

- **[Add new students or teachers]**

- **[Add new books]**

- **[Save records of who borrowed a given book and when]**

(back to top)


## 🚀 Live Demo 

- [at the moment not available]()

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

  - linters.yml and tests.yml files inside the .github folder

  - .rubocop.yml file

  - Gemfile 

### Setup

Clone this repository to your desired folder:

1- Navigate to the button on the top right green "code" button.

2- In the drop down menu choose "Download Zip" or clone it using git using the following command.

3- After extracting the files, you'll have my project on your local machine.

### Install

Install this project with:

- Run bundle install

### Usage

To run the project, execute the following command:

[$ ruby FILENAME.rb]

### Run tests

To run tests, run the following command:

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

👤 **Kelvin Benjamin**

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

- Twitter: [@kevoyout144](https://twitter.com/kevoyout144)

- LinkedIn: [Kelvin-Ben](https://www.linkedin.com/in/kelvin-ben-323043173/)

(back to top)


## 🔭 Future Features 

- [ ] **[add Person, Student, and Teacher classes]**

- [ ] **[use the "Decorator" design pattern]**

- [ ] **[set up associations]**

- [ ] **[add basic UI]**

(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 

Anyone who finds this project interesting is welcome to give it a star.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the opportunity

(back to top)


## ❓ FAQ (OPTIONAL) 

- **[How do i run the project in my local machine?]**

  - [You need to clone the project in your local environment through the terminal]

- **[What database are you using for this project?]**

  - [POSTGRESQL]

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