README

Get up and running with SCTP-ADDON.

Ruby version

    ruby 3.1.2p20 +

Rails version

    7.0.3.1 +

System dependencies

  rspec-rails #Testing Framework

  factory_bot_rails #Integration for factory_bot to rails

  shoulda-matcher

  database_cleaner #Easy clean DB for tests

  faker #Generate fake data

Configuration

Install project dependencies by running

  bundle install

Database creation

Copy/ rename the database.yml.example file to database.yml file. Configure any necessary parameter with values that correspond to your MySQL DB. The main parameters you would want to change are;

    username: ***********
    password: ***********

Database initialization

Create your DB by running

    rails db:create

Load your DB migrations by running

    rails db:migrate

Running the Application

Run the application on default Rails selected port by running

    rails server

Accessing the Endpoints

Since you have run the App on the default server, the endpoints have been exposed on

    localhost:3000

has mode and version appended to it making the url as

    localhost:3000/api/v1

Endpoints

    /meal_aggregates

    /meal_households

    /transfer_requests

    /transfer_responses

API Documentation

How to run the test suite

Services (job queues, cache servers, search engines, etc.)

Deployment instructions

• ...