Git Product home page Git Product logo

guestbook's Introduction

Guestbook

Welcome to the Guestbook! The Guestbook is designed to manage guestbook-entries for events e.g. a wedding or a birthday-party. The application is mainly written in Go, instrumented via OpenTelemetry and presented by the Grafana-LGTM-Stack for improved observability.

guestbook.png

Get started

You can easily get started via docker:

docker run -it -p 8080:8080 --rm ghcr.io/led0nk/guestbook:latest

Appliable flags:

flag default function
-addr localhost:8080 server address
-grpcaddr grpc address, e.g. localhost:4317
-db file://testdata path to database
-env testdata/.env path to .env-file
-domain 127.0.0.1 given domain for cookies/mail
-loglevel INFO define the level for logs

Configuration

In order to provide the guestbook with a working authentication system, which uses E-Mail validation, you need to pre-configure some variables in .env. It should at least contain the following:

TOKENSECRET="yoursecretofchoice"
EMAIL="[email protected]"
SMTPPW="dontforgettosetupyoursmtppw"
HOST="smtp.domain.com"
PORT="587"

Remember: You have to set up your smtp-password for your email-provider.

Important

The application should be defined as "pre-alpha" due to the lack of frontend-variation and code quality. There is much room for improvement e.g. creating multiple account-validation methods, reworking some frontend parts, writing more efficient code and many more...

guestbook's People

Contributors

led0nk avatar

Stargazers

Patrick avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.