In order to run this project, you need to have certain prerequisites set up on your machine. These prerequisites include:
To run the project, follow these steps:
-
Open the terminal in the project directory and run the command
go mod tidy
to ensure that all required dependencies are installed. -
Then, run the command
swag init
to initialize Swagger and generate the necessary API documentation. -
Finally, run the command
make run
to start the project.
The project will run on localhost:9000/
. To access the Swagger documentation click here.
By following these steps, the project will be up and running, and you will be able to access the API documentation through Swagger.
To access the GoDoc documentation, first install GoDoc on your machine. Open a terminal and type:
go get golang.org/x/tools/cmd/godoc
Then run the following command in the repository terminal:
godoc -http=:6060
GoDoc will run on localhost:6060
. To access the GoDoc documentation, just click here.