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

In this repo, I implement a library code that allows the user to store books and a students list
https://github.com/sebalp100/school-library

ruby

Last synced: 17 days ago
JSON representation

In this repo, I implement a library code that allows the user to store books and a students list

• Host: GitHub
• URL: https://github.com/sebalp100/school-library
• Owner: sebalp100
• License: mit
• Created: 2023-02-06T18:18:41.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-02-22T21:36:39.000Z (over 1 year ago)
• Last Synced: 2024-10-10T07:41:45.628Z (about 1 month ago)
• Topics: ruby
• Language: Ruby
• Homepage:
• Size: 35.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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)

  - [Usage](#usage)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 School library 

This is a repository that includes code that allows the user to create a list of students and teachers. It was made using ruby.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
Ruby

  


  Server

  


    
Ruby

  


Database

  


    
Ruby

  


### Key Features 

- Create Person

- Create Student

- Create Teacher

(back to top)


## 🚀 Live Demo 

Not available yet

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

- Ruby

- Ruby terminal

- Github account.

- Code editor (Visual Studio Code, Atom, etc.)

### Setup

Clone this repository to your desired folder:

cd my-folder

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

### Usage

To run the project, execute the following commands in your Ruby terminal:

- Open your terminal and run `irb` on the root folder of the project

- Run `require_relative 'person, student or teacher' ` command

- Run `person = Person.new(25, "John")` command to create a new person

- Run `student = Student.new(15, "Jane", "Class A")` command create a new student

- Run `teacher = Teacher.new(35, "Mike", "Math")` command to create a new teacher

- You can change the arguments in the methods to create different people

(back to top)


## 👥 Authors 

👤 **Sebastian Martin**

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

- LinkedIn: [Sebastian Martin](https://www.linkedin.com/in/sebastian-martin-956b2724a/)

(back to top)


## 🔭 Future Features 

- Improve optimization

- Store data

- Show students/teachers list

(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 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

- Hat tip to anyone whose code was used

- Microverse

(back to top)


## 📝 License 

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

(back to top)