Spy Cat Agency API (SCA-API) 🐱

Spy Cat Agency (SCA) is a management application designed to streamline the spy work processes of an agency using cats. It allows SCA to manage their agents (cats), track missions, and handle targets with detailed data entry and updates. The application features CRUD operations for cats and missions, including target assignment and note management, along with database. Built with Golang + Gin framework + PostgreSQL.

Task description here - TASK.md

How to run

Before running the application, ensure you create config.yaml file:

app:
  port: 8080
  base_path: "/api"
  db_url: "postgresql://user:[email protected]:5432/mycats?sslmode=disable"

see config_docker.yaml and config_example.yaml

Make sure you create tables in the database.

The script for table creation is located in sql/TableCreation.sql.

Example data script sql/ExampleDataInsertion.sql.

Native

Use make:

make run

Or build binary file and run:

make build
./bin/sca-api -config ./config.yaml

Docker

Run in docker:

docker compose up -d

this command will use config_docker.yaml file as config

127.0.0.1:8081 - database administration panel. Login [email protected] Password password.

Database connection parameters:

Host name/address: db
Port: 5432
Maintenance database: mycats
Username: user
Password: password

Postman collection

1. Open postman
2. Click on toolbar File->Import... (Ctrl+O)
3. Choose file sca-api.postman_collection.json