👨‍💻 Simple Retro

🔥 | Running the project

To run Simple Retro API, you need to have Golang in your machine. We recommend at least version 1.21.

1. 🧹 Clone the repository

git clone git@github.com:simple-retro/backend.git

2. 💻 Installing the dependencies

go get .

3. 🏃‍♂️ Running

go run main.go

📖 Swagger

Install swaggo if not installed in your system:

go install github.com/swaggo/swag/cmd/swag@latest

To update Swagger documentation run:

swag init -g internal/server/server.go

To format Swagger comments:

swag fmt

The documentation could be accessed in /swagger/index.html

📦 Buiding for production

To deploy the Simple Retro API, use Docker image.

docker build -t backend:<version> .

docker compose up -d

🔨 | Made With

• Go
• Gin
• Swag
• SQLite3
• Gorilla Websocket

⚖️ | License

Distributed under the MIT License. See LICENSE for more information.

---