productivity

module
v0.0.0-...-572132b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2024 License: MIT

README

Productivity

Tests codecov Go Report MIT License

The productivity service for the @abyan-dev distributed systems. It exposes a REST API for managing tasks, tracking study times and generating metrics for self-assessment.

Authorization: This service is meant to be used together with the abyan-dev/auth authentication service. All routes prefixed with api/productivity are restricted by a middleware that checks for a JSON Web Token (JWT) stored as a cookie access_token in the request.

Running the service locally

This service does not load environment variables from a file to ease orchestration, therefore you will need to either source .env.default or export all environment variables in .env.default manually.

You must first set up a local postgres database. There is a script for this using Docker:

make up-db

The server can now be run on port 8081 using:

make run

Directories

Path Synopsis
cmd
api command
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL