Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.38 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.38 KB
Raw

legoshichat-backend

legoshichat

Welcome to the legoshichat API, the official interface for the legoshichat. Unlock seamless integration and access the unique features of legoshichat through this official API.

This API employs JSON Web Tokens (JWT) for authentication. Please note that all endpoints, with the exception of the login and create account functionalities, necessitate the inclusion of an authorized JWT bearer token for access.

Documentation

Check out documentation here.

Also checkout the postman collection in the docs folder.

Roadmap

  • API Spec
  • API Implementation
  • Unit Testing 60% <
  • CI
  • CD

Steps To Run

  1. docker run --name gofr-pgsql -e POSTGRES_DB=legoshichat -e POSTGRES_USER=legoshiuser -e POSTGRES_PASSWORD=legoshipass -p 2006:5432 -d postgres:latest

  2. go run .

Run Tests go test ./... --cover

To monitor database docker exec -it gofr-pgsql psql --username=legoshiuser --dbname=legoshichat

Note: In the context of this project, the .env file is intentionally exposed publicly; however, it is crucial to emphasize that this practice is strongly discouraged in a production environment