https://github.com/rysth/ruby-school
RUBY School is a backend application, used to communicate with Students, Teachers, Books, and other relevant components from a School Library system. Built with Ruby.
https://github.com/rysth/ruby-school
Last synced: over 1 year ago
JSON representation
RUBY School is a backend application, used to communicate with Students, Teachers, Books, and other relevant components from a School Library system. Built with Ruby.
- Host: GitHub
- URL: https://github.com/rysth/ruby-school
- Owner: Rysth
- License: mit
- Created: 2023-10-02T16:25:49.000Z (almost 3 years ago)
- Default Branch: development
- Last Pushed: 2023-10-12T19:41:59.000Z (almost 3 years ago)
- Last Synced: 2025-02-07T23:46:51.421Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
John Palacios & Hajnalka Oltyan
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 RUBY School ](#-ruby-school-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**RUBY School** is a backend application, used to communicate with Students, Teachers, Books, and other relevant components from a School Library system. Built with Ruby.
Technologies
- **Add new students or teachers.**
- **Add new books.**
- **Save records of who borrowed a given book and when.**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
### Setup
Clone this repository to your desired folder:
```
git clone https://github.com/Rysth/RUBY-School.git
cd RUBY-School
code . (To open VS Code Editor)
```
Then, you will change everything you want!
### Install
Install this project with:
- 1. Install ruby following this [documentation](https://www.ruby-lang.org/en/documentation/installation/)
- 2. Use the `build install` command within your folder using WSL to install all the dependencies automatically.
### Usage
To run the project, execute the following steps:
- 1. Open your terminal (WSL/Ubuntu Terminal)
- 2. Check if you have ruby and rubocop installed (if not follow the previous chapter).
- 3. Type 'ruby main.rb' in the root folder to execute the application.
- 4. Finish
👤 **John Palacios**
- GitHub: [@rysthcraft](https://github.com/Rysth)
- Linkedin: [@johnpalacios](https://www.linkedin.com/in/john-palacios-rysthcraft/)
👤 **Hajnalka Oltyan**
- GitHub: [@hajnaloltyan](https://github.com/hajnaloltyan)
- LinkedIn: [Hajnal Oltyan](https://www.linkedin.com/in/hajnalka-oltyan/)
- [ ] **Create an attractive user interface by connecting the application with React**
- [ ] **Store the data within a PostgreSQL Database**
- [ ] **Develop a Classroom item menu to create new classroom objects**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project feel free to watch it and take some features that will enhance your project as well.
I would like to thank the Microverse Team for reviewing my code and making me a better professional.
This project is [MIT](./LICENSE.md) licensed.