Skip to content

maksymstoliarov/junior-test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Junior Test task. Rest API CRUD for books

This project provides a REST API for managing a collection of books, allowing basic CRUD (Create, Read, Update, Delete) operations.

Features

  • CRUD operations for books
  • Dockerized environment for easy setup
  • Swagger documentation for API endpoints

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker and Docker Compose
  • Make (for running Makefile commands)

Installation

  1. Create .env file based on .env.example. Change values if needed
  2. Run docker container
make docker-up
  1. Apply migrations
make migrate-up
  1. Run application
make run

Usage

API Base URL: localhost:8000
Swagger Documentation: For a detailed look at the available API endpoints and their specifications, visit the Swagger documentation at: localhost:8000/swagger/index.html