/thirsty-jotter-go-api

Primary LanguageGo

ThirstyJotter API (WIP)

Overview

TBA

Features

  • RESTful API endpoints for CRUD operations
  • JWT Authentication (WIP)
  • Swagger documentation (WIP)
  • Dockerized application for easy setup and environment (WIP)

Folder structure

TBA

Getting started

Prerequisites

Installation

  1. Navigate to the directory

cd /cmd/server/

  1. Start the server

go run .

Environmental variables

You can set the environmental variables in the .env file. Here are some important variables:

  • XATA_API_KEY
  • XATA_DB_URL
  • XATA_BRANCH

API documentation

TBA

Usage

TBA

Endpoints

  • GET /xata_plants: Get all plants.

Authentication

TODOs

  • integrate swagger documentation
  • connect with xata.io
  • dockerizy it
  • add authentication
  • add all kind of tests
Resources