maas

command module
v0.0.0-...-6879cb0 Latest Latest
Warning

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

Go to latest
Published: Mar 22, 2024 License: MIT Imports: 10 Imported by: 0

README

maas

Memes-as-a-Service

Introduction

This project is an example of a simple REST microservice in go. It is intended to provide "memes as a service".

Using this code

This repo is published under an MIT License which tends to be flexible for the user while still protecting the creator. Please feel free to use this code and also to submit Pull Requests with any fixes/improvements/suggestions/etc. Also, if you use code from the repo I request (but do not require) that you star the repo in GitHub.

All code in this repo was written by me, but much of the code is actually reused from other projects I've done including:

Running the code

Setup development environment

The server uses properties stored in a .env file. To generate said file, from the project root run scripts/create_env.sh. If you want to connect to the DataStax Astra database, you will need to provide a token, otherwise in-memory storage will be used.

Running the Server

From the project root run go run .

Testing the Server

Here are some example CURL commands that can be used to access the running server:

  • curl --header "Authorization: aeca88d8-af10-4316-99cc-4ae3497ce8d0" http://localhost:8081/api/v1/memes?lat=40.730610\&lon=-73.935242\&query=food
  • curl --header "Authorization: aeca88d8-af10-4316-99cc-4ae3497ce8d0" http://localhost:8081/api/v1/councounts/
Prerequisites
  • Go (see the go.mod file for the correct version)
  • Git
  • Database token (optional)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
pkg

Jump to

Keyboard shortcuts

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