Skip to content
This repository has been archived by the owner on Feb 25, 2023. It is now read-only.

Latest commit

 

History

History
69 lines (47 loc) · 1.53 KB

README.md

File metadata and controls

69 lines (47 loc) · 1.53 KB
Raw

Kegger

Kegger - RSVP Manager

Kegger is an Event / RSVP manager to keep track of guests attendance. The application is split in two modules: the API (Go) and the frontend(Vue.js).

Features

  • Create parties with guests
  • Send invite by email (only SendGrid supported as of now)
  • Create new / customize invitation email template
  • Create multiple administrators (hosts)
  • Keep track of
    • Guests Attendance
    • Invitations sent / not sent
    • Invitation was opened by guest

Running the project using Docker

You can quickly get started using the project with Docker:

docker-compose up

Once Docker is finished building the images open a browser and head over to http://127.0.0.1:8080/ The default email to login is [email protected] and the password is admin.

Building the project locally

Backend / API

Kegger's API is built using the Echo Go web framework.

Requirements

  • Go 1.12+
  • Go Echo v4.1.5 (later versions are broken in the way they handle bingings & params
  • Postgres 10+
  • SendGrid account for being able to send out the email invites (optional)

Build

cd api
go build -o kegger
./kegger

Frontend

Kegger's Frontend is built with Vue.js.

Requirements

  • Node.js 12+
  • Vue 2.6+
  • Vuex 3.1+

Build

cd frontend
npm install
npm run serve

Open your browser and head over to http://127.0.0.1:8080/