phc
/
go-maths-api
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Simple Go API to check whether an user is a Math student or not.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Commits
1 Branch
0 Tags
35 KiB
Go 93.8%
Dockerfile 6.2%
 
 
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
Francesco Minnocci 04c540647a Add 'docker-compose.yml' 10 months ago
.env.example varie migliorie 10 months ago
.gitignore varie migliorie 10 months ago
Dockerfile varie migliorie 10 months ago
README.md added some notes in the readme 10 months ago
docker-compose.yml Add 'docker-compose.yml' 10 months ago
go.mod varie migliorie 10 months ago
go.sum varie migliorie 10 months ago
main.go varie migliorie 10 months ago

README.md

Go Maths students API

A simple Go API whose only purpose is to check whether an user is a Maths student or not.

Prerequisites

  • An environment variable AUTHPDS_TOKEN containing the authentication token for the external API.

  • An environment variable named SECRET containing the secret token for authorization.

Development

Development

# Create a ".env" file from the given template and update as needed
$ cp .env.example .env

# Start the server
$ go run -v .

# Build to binary
$ go build -v -o ./bin/go-maths-api .

Deploy

To build and run the image from the provided Dockerfile:

# Create a ".env" file from the given template and update as needed
$ cp .env.example .env

$ docker build -t go-maths-api .
$ docker run -d --restart always -p 8080:8080 --name go-maths-api go-maths-api

Client Usage

An example request to the local Docker image (with SECRET defined in your environment):

$ curl "localhost:8080/check-maths-user?user=f.minnocci" -H "Authorization: Bearer $SECRET"

Successful JSON response:

{
    "result": true
}

Notes