This project is designed to create a suite of APIs using Gin Web Framework and Gorm, the ORM library for Golang. It aims to provide a robust backend solution for financial operations.
The Pismo project is structured to support scalable and maintainable API development. It includes a Dockerized PostgreSQL database and utilizes the Gin framework for handling HTTP requests and Gorm for object-relational mapping.
Before running this project, you must have the following installed:
- Docker and Docker Compose
- Go programming language
- Git (for version control)
To get the application up and running, follow these steps:
First, clone the repository to your local machine:
git clone https://github.com/shiguemori/pismo.gitUse docker-compose to spin up the PostgreSQL database container:
docker-compose up -d postgresNavigate to the project directory and run the application with the following command:
go run main.goDuring development, you might want to refresh your database and application state. To reset your environment use the following commands:
docker-compose down -v
docker-compose up -d postgres
go run main.goOnce the application is running, the API documentation can be accessed through Swagger at the following URL:
Here you can view the list of available endpoints, their expected request formats, and try out the API calls directly from the browser.
For security and configuration management, the application utilizes environment variables. Ensure you have a .env file at the root of your project with the necessary variables set, such as POSTGRES_USER, POSTGRES_PASSWORD, and POSTGRES_DB.
Our project comes with a comprehensive test suite designed to ensure the highest standards of quality. To execute the tests and verify that all components behave as expected, follow the steps below:
Run All Tests: To execute all tests across the project, use the following command at the root of the project:
go test ./...- This will recursively run all tests in all subdirectories.
Test Coverage: To assess the test coverage across the project, you can generate a coverage report by running:
go test ./... -cover- This command provides a summary of the coverage percentage per file.
Coverage Profile: If you need a detailed coverage report, you can generate a coverage profile with:
go test ./... -coverprofile=coverage.out- This command creates a file named coverage.out containing the coverage data.
View Coverage in Browser: For a visual representation of the coverage, you can render the coverage profile in HTML format and view it in your web browser:
go tool cover -html=coverage.out- This will open a webpage displaying the code coverage, with untested lines highlighted.
By regularly running these tests and analyzing coverage, we can maintain and improve the project's quality over time. Make sure to run the test suite before pushing code changes to ensure that all functionalities are working as intended.
The project includes a Postman collection with a set of requests to test the API. You can import the collection into Postman and run the requests directly from the application.
Contributions to the project are welcome. Please follow the standard fork and pull request workflow. Ensure that you write or update tests as necessary and adhere to the existing coding style.
- email: shiguemori@hotmail.com
- phone: +55 11 975676977
- LinkedIn: https://www.linkedin.com/in/shiguemori-fullstack-dev/
- Github: https://github.com/shiguemori
