Categorygithub.com/LitPad/backend
modulepackage
0.0.0-20241229220844-cb4f0a5bd849
Repository: https://github.com/litpad/backend.git
Documentation: pkg.go.dev

# README

LITPAD V1 (WORK IN PROGRESS)

alt text

FIBER DOCS: Documentation

GORM DOCS: Documentation

PG ADMIN: Documentation

How to run locally

  • Download this repo or run:
    $ git clone [email protected]:LitPad/backend.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

# Packages

No description provided by the author
No description provided by the author
Package docs Code generated by swaggo/swag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author