Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gjuliao/curriculum

This is a school library app built in Ruby, that hosts the records of borrowed books among students and professors.
https://github.com/gjuliao/curriculum

Last synced: 6 days ago
JSON representation

This is a school library app built in Ruby, that hosts the records of borrowed books among students and professors.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Curriculum

** Curriculum ** Is a Ruby project that creates a library book project, consisting of hosting the records of borrowed books from students and teachers.

## 🛠 Built With

### Key Features

- **Back-End Ruby operations**

(back to top)

## 💻 Getting Started

To get the content of this project locally you need to run the following commands in your terminal:

and follow these steps.

### Prerequisites

- IDE(code editor) like: **Vscode**, **Sublime**, etc.
- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)

### Setup

Clone this repository to your desired folder:

1. Download the **Zip** file or clone the repo with:
```bash
git clone [email protected]:gjuliao/curriculum.git
```
2. To access cloned directory run:
```bash
cd curriculum
```

### Install

> To install linters and other project's dependencies run:

```bash
bundle install
```

### Usage

To run the project, execute the following command:
```bash
ruby main.rb
```

### Run tests

For tracking linter errors in Ruby files run:

```
rubocop .
```

(back to top)

## 👥 Authors

👤 **Giovanni Juliao**

- GitHub: [@gjuliao](https://github.com/gjuliao)
- LinkedIn: [giovanni-juliao](https://www.linkedin.com/in/giovanni-juliao/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/gjuliao/curriculum/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give it a star.

(back to top)

## 🙏 Acknowledgments

I would like to thank the Microverse team for the creation of this example project.

(back to top)

## 📝 License

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

(back to top)