caner-cetin / project-persephone

Food review backend.

Project Persephone

Name to be decided later.

Running The Project

You need Go. Which version? I dont know. Get the latest one till I pull a Dockerfile.

Clone the repository, chdir into the repository/src, run

docker compose up -d

go mod tidy

curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

$(go env GOPATH)/bin/air 

this is very, very, very WIP project. I dont even know what is happening here anymore tbh.

project-persephone's Issues

city struct design and /cities endpoint

mock db integration for psql testing

Two possible candidates:

https://github.com/DATA-DOG/go-sqlmock

If we want container based approach, we can go

https://github.com/orlangure/gnomock

too, but tests may fail randomly, sqlmock is far more stable.

Testify integration with suite for server initialization / middleware testing

Almost all routers are dependent on the Server struct, so we need a testify suite that will initialize a Server in SetupTest function.

https://github.com/stretchr/testify#suite-package

This will also help us test middlewares.

CI with unit testing, CD to be decided later

Need to run unit tests on every commit to the master.

Might split up as master/test and push from test to master if unit tests pass at test branch.

CD to be decided later, but %100 change it will be a deployment stage on EC2 server with Docker container.

unit tests for /user/signup

places db table design

Corresponding struct lies in helpers.go

type Restaurant struct {
	Name         string
	Cuisine      string
	OpeningHours string
	Phone        string
	Website      string
	Address      string
	Latitude     float64
	Longitude    float64
}

swagger documentation with swaggo/swag

https://github.com/swaggo/swag

use structs in unit tests instead of raw json payloads

Change

`
{
    "email":"[email protected]",
    "username":"canercezarapyapardostlar",
    "password":"123$sagopaHaksizdi",
    "test":true,
    "phoneNumber": "[phone]",
    "city": "BURSA",
    "country": "TURKEY"
}`

to

	var payload UserSignupRequest
	payload.Email = "[email protected]"
	payload.Username = "canercezarapyapardostlar"
	payload.Password = "123$sagopaHaksizdi"
	payload.Test = true
	payload.PhoneNum = "[phone]"
	payload.City = "BURSA"
	payload.Country = "TURKEY"

unit tests should also aim for showing future contributors to how things works around.

/updateUser and /home endpoint for U and R at user CRUD

/home will be simply the response of /login.

only accept token logins.

find city , country, state data and create tables

better error logging with interfaces and structs, separate custom error logging

/user/update for U of CRUD in user endpoints

convert zap to slog

auto OTEL instrumentation and assign tracers individually for each endpoint

integrate postman documentation with github pages

Export it as PDF, https://stackoverflow.com/a/46977801, host the PDF in github pages or somewhere password protected.

Due to GitHub pages being always public, not being dependent to the repo.

unit tests for /user/login

extensive jaeger attributes on error, like traceback request id, jwt contents

/get for city, state, and countries

/user/delete endpoint