README.md

README

Link to deployed app:

SmallApiWrapper

Requirements

Make sure you have the following installed on your system:

• Ruby version 3.1.2
• Bundler

Installation

1. Clone the repository:

git clone git@github.com:yaroslavrick/small_api_wraper.git

2. Move into the project directory:

cd simple-api-wrapper

3. Install dependencies using Bundler:

bundle install

4. Create .env and .database.yml file from examples and update the values:

cp .env.example .env

cp config/database.example.yml config/database.yml

5. Setup Docker services (PostgreSQL and Redis):

docker-compose up

Ensure that the ports configured in .env do not conflict with your running services.

6. Create the database:

bundle exec rails db:create

7. Run database migrations:

bundle exec rails db:migrate

8. (Optional) Run seed data to create some sample data:

bundle exec rails db:seed

Usage

To start the app, run the following command:

bin/dev

Once the server is running, open your web browser and go to http://localhost:3000 to access the app.

To run console app:

ruby my_program.rb new --type education --participants 1 --price_min 0.1 --price_max 30 --accessibility_min 0.1 --accessibility_max 0.5

ruby my_program.rb list

Make sure you have local server running to have console app working.

Testing

To run the test suite, use the following command:

bundle exec rspec