To use this project, you need to follow these steps:
- Clone the repository:
git clone https://github.com/username/repo-name.git
- Install the dependencies:
go mod download
- Build the application:
go build
- Run the application:
./main
The project includes a Makefile to help you manage common tasks more easily. Here's a list of the available commands and a brief description of what they do:
make run
: Run the application without generating API documentation.make run-with-docs
: Generate the API documentation using Swag, then run the application.make build
: Build the application and create an executable file namedgopportunities
.make test
: Run tests for all packages in the project.make docs
: Generate the API documentation using Swag.make clean
: Remove thegopportunities
executable and delete the./docs
directory.
To use these commands, simply type make
followed by the desired command in your terminal. For example:
make run