Demo project [backend]

A Valid PR

For a PR (Pull Request) to be considered valid, it must fulfill the following criteria:

Must contain functionality.
Include unit tests.
Provide Swagger documentation.
If required, set up migrations.

Execute with Docker Compose

docker-compose up --build

Testing Endpoint

You can test various endpoints by using the curl command. Below are examples of how to test different operations:

POST: To create a new expense:

curl -X POST -H "Content-Type: application/json" -d '{
    "description": "Lunch expense",
    "amount": 15.50
}' http://localhost:8080/expenses

GET: To retrieve an expense by its ID:

curl -X GET http://localhost:8080/expenses?id=<expense_id>

PUT: To update an existing expense:

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "<expense_id>",
    "description": "Updated expense description",
    "amount": 20.00
}' http://localhost:8080/expenses

DELETE: To delete an expense by its ID:

curl -X DELETE http://localhost:8080/expenses?id=<expense_id>

Documentation

To generate Swagger documentation for your API, use the following commands:

swag init swagger generate spec -o ./swagger.json

tests

Create mocks with go mock

cd services
mockgen -package=mocks -destination=./mocks/mock_expense_service.go github.com/demo-talent/services ExpenseService

cd repository
mockgen -package=mocks -destination=./mocks/mock_expense_repository.go github.com/demo-talent/repository ExpenseRepositoryInterface

Run tests

go test ./...

Infra

Terraform commands

terraform plan
terraform apply

Modify hosts file on ansible: ec2-instance ansible_host=
Run comamnd

ansible-playbook -i hosts docker-playbook.yml --private-key /path/to/private-key.pem -e "db_password=your_secure_password"
ansible-playbook -i inventory.ini playbook.yml

Show Demo

Implement filters by property on expenses (Reduced steps)

1.- create new branch
2.- Implement on repo the code for filtering
3.- create the handler
4.- Implement unit tests
5.- Update swagger documents
6.- creae migratiosn files if needed
7.- Commit and push
8.- Create or update smoke tests
9.- deploy to production
10.- Monitor app

gmgalvan / demo-talent