gymulty

A multi-tenant rest api for managing gym operations.

Note: This api is still in early stages and updates will be added as they are ready to be shipped.

Getting started locally

Download the project

git clone https://github.com/emanuelquerty/gymulty.git

Download all dependencies

First make sure you have Go installed in your local computer. If not, you can download it by going to https://go.dev/doc/install and following the installation process. Once that is done, open the project you've just cloned in your editor of choice and run the following command in the terminal:

go get

This will add all required dependencies and install them.

Environment variables

Create a .env file in the root of the project with the following configuration variables:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=gymulty
DB_USERNAME=postgres
DB_PASSWORD=YourPostgresPassword

Run the project

go run ./cmd/http/.

This will start a server listening on port 8080

Run tests

go test ./...

Build the project

go build -o gymulty ./cmd/http

This will build the executable named gymulty on the project root directory.

Start the server

Run the generated executable:

./gymulty

This will spin up the api server on port 8080

Documentation

Once the server is running, you can access the full API Documentation on http://localhost:8080/api/swagger/index.html to interact with the API via swagger UI or your tool of choice.