README.md

Nock Backend

A team-based attendance app

---

Features

• Auth via email-password and google/other social login.
• Create teams and send out invite links.
• Discover open teams.
• Join teams and await verification by team admins (if enabled for that team).
• Get promoted to team admin by team creator/superadmin.
• Create meetings (attendable by all team members) for a team with locations, timings, etc as a team admin.
• Get notified of upcoming meetings.
• Start and end meetings, and take accurate and timebound location-based attendance of members.
• Other team and meeting admin features.
• See attendance reports for meetings.
• Create meetings for subgroups in teams.

Dependencies

• Go

Running

Prerequisites

• Docker

Directions to Install

git clone https://github.com/GDGVIT/attendance-app-backend.git

Add all environment variables from the .env.example file. For local dev, you can just add all to a .env file. For prod, utilise some sort of secret management for the marked variables (such as GOOGLE_CLIENT_SECRET) before deploying.

Direction to Execute

# dev (with live reload)
make dev

# prod
make prod

# remove prod container
make remove-prod

The server should be up on 0.0.0.0:8000

Contributors

Anirudh Mishra

Made with ❤ by DSC VIT