Warehouse Automation System API

This repository contains the source code for the Warehouse Automation System web service. This project was featured in the TerroByte Hackathon 2024 at Turin Polytechnic University in Tashkent, and received the third place.

Technologies Used

• Haskell
• Servant (API)
• PostgreSQL (DB)
• Docker
• GitHub Actions (CI/CD)

Getting Started

First, clone the repository on your local machine:

$ git clone https://github.com/junkidesu/warehouse-automation-system

Prerequisites

Build Tools

To build and run the application locally, ensure that the following are installed:

• Stack
• Cabal
• Docker

Stack and Cabal can be installed either independently or with the GHCup tool.

Services

The application uses PostgreSQL for the database. Thus, a running PostgreSQL server (either local or remote) is required.

Environment Variables

See .env.sample to see the environment variables that must be set. You can either place them in a .env file, or supply them directly to the executable.

Build and Start Executable

At the root of the repository, run the following:

$ stack install
$ warehouse-automation-system-exe

Start in Container

You may start the application along with a local PostgreSQL server using Docker Compose.

$ docker compose -f docker-compose.dev.yml up

Documentation

Swagger documentation of the API is available at https://warehouse-automation-system-main.onrender.com/swagger-ui.