Welcome to The Sheriff’s Project!

The Sheriff Documentation

Introduction

This part of the documentation is intended to birefly introduce The Sheriff application.

• Introduction
  • Documentation Layout

Design

• Design
  • Hexagonal Architecture
  • The Sheriff Design

Technologies

• Technologies
  • GNU Make
  • Docker
  • Curl
  • Python
  • Flask
  • SQLAlchemy
  • Smtplib
  • Contracts
  • References

Development methodology

• Development Methodology

API Documentation

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• The Sheriff Application
  • Gang
  • Outlaw
  • Raid
• The Sheriff Domain
  • Gang
  • Outlaw
  • Raid
  • Mail
• The Sheriff Infrastructure
  • Controllers
  • Repositories
  • Notifiers

Functionality - Application usage

Here’s all you need to run and test The Sheriff application.

• The Sheriff Usage
  • Runtime Requirements
  • Validating use cases
  • Tests
  • Development Requirements

Conclusions

Small section about the lessons learned after the project.

• Conclusions