featws-api

README

Featws API

How to run

In order to run this project, you need to have certain prerequisites set up on your machine. These prerequisites include:

• Golang
• Swaggo
• Docker

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.

• Open Docker on your machine or a similar application to ensure that it is working properly. Then, open the terminal in the project repository and run docker compose up.

• Once the containers are started and running, run the command make run in the project terminal to start the project.

The project will run on localhost:9007. 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.

GoDoc

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.