Categorygithub.com/jichong-tay/playlist-api
modulepackage
0.0.0-20240330040016-a87b69b98b06
Repository: https://github.com/jichong-tay/playlist-api.git
Documentation: pkg.go.dev

# README

Playlist Backend Server


Capstone Project of a Backend Go Server.

Food Subscriptions

To help our users avoid the hassle of deciding what food to order, we want to create a Food Playlist! We need a beautify UI where users can input food preferences, and based on such preferences generate a ""playlist"" of food deliveries. For example, a user might want to eat halal Hamburgers, and the user wants a hamburger delivered every Thursday at 2pm. The system would then generate a ""playlist"" of different hamburger dishes from various restaurants such that each Thursday at 2pm the user receives a hamburger without any intervention. The user should be able to pause the playlist if they are traveling etc.


Steps to run

  1. Ensure Golang is install.

https://go.dev

  1. Ensure golang-migrate is install.
brew install golang-migrate
  1. Run the following cmd for setup
make start-and-migrate
  1. Start Backend Server
make server

Others

Docker replacement

brew install docker docker-compose
brew install colima
colima start

Install SQLC

https://docs.sqlc.dev/en/latest/overview/install.html

Install Go Mock https://github.com/uber-go/mock

go install go.uber.org/mock/mockgen@latest

Add Path

nano ~/.zshrc
export PATH=$PATH:~/go/bin

Notes

  1. make postgres-image (download postgres image)
  2. make postgres (start container)
  3. make createdb (make dropdb)
  4. make sqlc (if sql files are not generated)
  5. make migrateup (make migratedown)
  6. make test

Database Design

playlist

Demo Preview

Demo Preview Video

# Packages

No description provided by the author
No description provided by the author
Package util is a package that contains utility functions for the playlist service.