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

https://github.com/mughieams/rentalcar-cli

🚘 A simple rental car simulation program using CLI
https://github.com/mughieams/rentalcar-cli

car-rental-app command-line-app ruby

Last synced: over 1 year ago
JSON representation

🚘 A simple rental car simulation program using CLI

Awesome Lists containing this project

README

          

# rentalcar-cli

A simple rental car simulation program using CLI.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

1. PostgreSQL `12.1`. You can follow this [instruction](https://www.postgresql.org/docs/current/tutorial-install.html) for the installation procedure.
1. Ruby `2.6.0`. You can follow this [instruction](https://www.ruby-lang.org/en/documentation/installation/) for the installation procedure.
2. Bundler `2.1.4`. You can execute this command below:
```console
$ sudo gem install bundler
```

### How to use

These commands below will help you to use this project properly.

For the first, you need to clone this repository then run:

```console
$ bundle install --path vendor/bundle
```

Next, you must make a new `_config.yml` file inside `config` directory using your own `postgres` configuration. For the format, you can write using this format below:

```yml
db_host: ''
db_user: ''
db_pass: ''
db_name: ''
```

### When working

#### Running the tests

Open this project directory on terminal and execute this command below:

```console
$ bundle exec rspec spec
```

#### Verifying code style

Open this project directory on terminal and execute this command below:

```console
$ bundle exec rubocop
```

You can reformat the code by executing:

```console
$ bundle exec rubocop -a
```

### When running this project

Open this project directory on terminal and execute this command below:

```console
$ bundle exec exe/rentalcar
```

## Acknowledgments

Thanks to [**@sweetescape**](https://www.sweetescape.com/en) for giving me the opportunity to do this coding test.