gushul/amarket_homework

Theatre Schedule Management API

This is a simple API for managing a theatre's schedule. It's built with Ruby on Rails and PostgreSQL.

Features

• CRUD operations for performances.
• Dates validation: avoid overlapping performances.
• Pagination for index endpoint.

Requirements

• Ruby 3.2.1
• Rails 7.0.0
• PostgreSQL 13
• Docker and Docker Compose(if you want use docker)

Setup

1. Clone the repository:

   git clone [email protected]:gushul/amarket_homework.git

2. Navigate to the project directory:

   cd amarket_homework

3. Build and set up the project using the Makefile:

   make setup

Usage

• To start the server:

  make server

• To open a Rails console:

  make console

• To run the test suite:

  make test

• To run database migrations:

  make migrate

• To take down the Docker environment:

  make down

API Documentation

The API documentation is available at http:localhost:3000/api-docs.