https://github.com/mmggyy66/school-library

https://github.com/mmggyy66/school-library

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mmggyy66/school-library
• Owner: MMGGYY66
• Created: 2023-04-11T17:59:38.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-08-02T15:37:29.000Z (over 1 year ago)
• Last Synced: 2024-05-17T15:36:22.033Z (8 months ago)
• Language: Ruby
• Size: 584 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  
School Library



# 📗 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](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [school-library] 

**[school-library]** is a a Ruby app that allows teachers & students to manage school libraries and book rentals .

## 🛠 Built With 

### Tech Stack 

  Client

  


    
Ruby

    
Ruby on Rails

  


  Server

  


    
ROR

  


Database

  


PostgreSQL

  





### Key Features 

- **Users can be created as students or teachers**

(back to top)


## 💻 Getting Started 

To get a local copy of this project and run it in your computer, follow these steps.

### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

### Setup

To get a local copy up and running follow these simple example steps.

Clone this repository in the desired folder:

```

cd my-folder

git clone https://github.com/MMGGYY66/school-library

```

### Install

To install this project:

```

cd School-Library

code .

bundler install

```

### Usage

To run the project, execute the following command:

```

ruby teacher.rb

ruby student.rb

```

### Run tests

To run the project tests, execute the following command:

```

rspec spec

```

(back to top)


## 👥 Authors 

👤 **Mohamed Gamil Eldimardash**

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohamed-eldimardash-0023a3b5/)

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

- Facebook: [facebook](https://www.facebook.com/MOHAMED.ELDIMARDASH/)

- StackOverflow: [stackoverflow](https://stackoverflow.com/users/13605630/mohamed-gamil-eldimardash)

(back to top)


## 🔭 Future Features 

- [ ] **Add new books.**

- [ ] **Add new teachers.**

- [ ] **Add new students.**

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

(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 feel free to frok it and use it as you need.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/MMGGYY66/school-library/blob/oop-school/MIT.md) licensed.

(back to top)