Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gh-reza/oop-school

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/gh-reza/oop-school
Owner: Gh-Reza
License: mit
Created: 2023-08-29T05:10:38.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-09-02T16:48:11.000Z (over 1 year ago)
Last Synced: 2024-12-30T13:37:09.844Z (28 days ago)
Language: Ruby
Size: 25.4 KB
Stars: 5
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # OOP School

# Table of Contents

- [Built With](#built-with)

  - [Tech Stack](#tech-stack)

  - [Key Features](#key-features)

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

## Built With 

### Tech Stack 

  


    Ruby

  


### Key Features 

- **Save the students and books records**

- **List the books and students**

- **Add new students and books**

- **Add rent books to students**

- **Correct entered names**

(back to top)


## Getting Started 

### Prerequisites

- **Ruby**

  - If you don't have Ruby installed on your computer, follow the instructions on [this page](https://www.ruby-lang.org/en/documentation/installation/) to install it.

### Setup

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

1. Clone the repo or download the Zip folder:

```sh

git clone https://github.com/Gh-Reza/oop-school.git

```

2. Navigate to the project folder in your terminal and run the following command to install the necessary gems:

```sh

bundle install

```

3. Run the following command to start the program:

```sh

ruby person.rb

ruby student.rb

ruby teacher.rb

```

(back to top)


### Usage

1. Ensure that Ruby is installed on your system.

2. Run the following command to start the program:

```sh

ruby person.rb

ruby student.rb

ruby teacher.rb

```

(back to top)


## Authors 

👤 **Reza Merzaie**

- 👤 GitHub:   [Gh-Reza](https://github.com/Gh-Reza)

- 👤 Twitter:  [Reza](https://twitter.com/reza-mezaie)

(back to top)


## Future Features 

- **Add books**

(back to top)


## Contributing 

We welcome contributions, especially bug fixes and feature additions.

If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Make your changes and commit them with descriptive commit messages.

4. Push your changes to your forked repository.

5. Submit a pull request to the main repository, explaining your changes in detail.

Please adhere to the coding conventions and guidelines specified in the project.

Feel free to check the [issues page](https://github.com/Gh-Reza/oop-school/issues).

(back to top)


## Support 

Give a ⭐️ if you like this project!

(back to top)


## Acknowledgments 

I would like to thank Microverse and Ruby for making this possible.

(back to top)


## License 

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

(back to top)