mood-harbour-backend

command module
v0.0.0-...-aef9128 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2024 License: GPL-3.0 Imports: 7 Imported by: 0

README

Mood Harbour

A project for my Software Engineering course. Frontend Repo at https://github.com/anirudhgray/mood-harbour-frontend

Features

  • Built using Golang, Gin, Gorm and PostgreSQL.
  • Dockerised via docker-compose.
  • Auth: Login, Register, Forgot Password, Reset Password, Delete Account
  • Mood Tracking Features: Add Mood Entries at any time, and see your mood history.
  • Facial Expression Detection to detect your mood in real time.
  • Publish helpful resources, and vote on resources present in the community.
  • Get personalised recommendations via collaborative-filtering for mood related resources.
  • Send mails for Auth related matters.
  • Certain users can have admin access.

Running Locally

  1. Ensure that you have Docker installed on your system.
  2. Clone the repo.
  3. Create a .env in the project root, and copy .env.example into it. Generate a random API_SECRET, and obtain a mailtrap API key for email sending.
  4. cd mood-harbour-backend
  5. make dev
  6. This will spin up the docker-compose, and the containers needed to run the dev project (the main server, the database server, and one container for the DB admin view).

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
infra
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
utils

Jump to

Keyboard shortcuts

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