Pata Amiga API

About Pata Amiga API

• The Pata Amiga is an open source customizable and extensible platform for helping homeless animals, It provides a simple and scalabel soluction for users and NGOs
• Project status:
• P.E.T Support

UML

Table of contents

• Pata-Amiga-API
  • About / Synopsis
  • UML
  • Documentation
  • Getting starter
    • Content
    • Requirements
    • Build
  • Contributing / Reporting issues
  • License

Documentation

Sample:

• You can see documentation on localhost.

Getting starter

• Clone the repository:

git clone https://github.com/PET-foundation/Pata-Amiga-API
cd Pata-Amiga-API

• Change the database configs in yours applicatio.yml

• Run on:

Unix

./mvnw clean install

Windows

mvnw.cmd clean install

• Run the Spring Boot:

Unix

./mvnw spring-boot:run

Windows

mvnw.cmd spring-boot:run

or

• You can Run with docker. You can run oficial docker image:

docker run matheusvict/pataamiga

or

• build with Dockerfile

docker build .

• Open on your localhost

Content

Description, sub-modules organization...

Requirements

Java 17+ MySQL

Build

 mvn clean install

Build options:

 mvn clean install -Dspring.profiles.active=dev

 mvn clean install -Dspring.profiles.active=prod

 mvn clean install -Dspring.flyway.enabled=false

Contributing / Reporting issues

• First of all, to contributing, clone the repository:

git clone https://github.com/PET-foundation/Pata-Amiga-API

cd Pata-Amiga-API

docker compose up

or

mvn clean package -Dspring.profiles.active=dev

And just do your part

License

Gnu license