socialnet-v6

README

SOCIALNET V6

A realtime social networking API built with Fiber & GORM ORM

FIBER DOCS: Documentation

GORM DOCS: Documentation

PG ADMIN: Documentation

How to run locally

• Download this repo or run:

    $ git clone git@github.com:kayprogrammer/socialnet-v6.git

In the root directory:

• Install all dependencies

    $ go install github.com/cosmtrek/air@latest 
    $ go mod download

• Create an .env file and copy the contents from the .env.example to the file and set the respective values. A postgres database can be created with PG ADMIN or psql

• Run Locally

    $ air

• Run With Docker

    $ docker-compose up --build -d --remove-orphans

OR

    $ make build

• Test Coverage

    $ go test ./tests -v -count=1

OR

    $ make test