https://github.com/kwakubiney/cli-rest-client

CLI client to interact with Postgresql to create, read and update records.
https://github.com/kwakubiney/cli-rest-client

Last synced: about 1 month ago
JSON representation

CLI client to interact with Postgresql to create, read and update records.

• Host: GitHub
• URL: https://github.com/kwakubiney/cli-rest-client
• Owner: kwakubiney
• Created: 2022-07-13T13:59:12.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-11T08:21:37.000Z (over 2 years ago)
• Last Synced: 2024-10-13T19:08:36.955Z (2 months ago)
• Language: Go
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.MD

Awesome Lists containing this project

README

        
# CLI REST client

This client makes REST API requests using the CLI.

# Development Usage (Installing)

- Run `docker-compose up` to spin up Postgres service for the API service

- Create an `.env` file in root directory by cloning the `.env.test` file. 

- You can modify .env but it is compatible with postgres service being spun. If modified, `docker-compose.yaml` must be modified to correspond.

- `cd` into `internal/migrations` and run `goose postgres "postgresql://postgres:postgres@localhost:5432/gamedev?sslmode=disable" up` to make migrations.

- Build the go project with `go build -o gamedev cmd/main.go` in root and run `--help` to see subcommands, you can check out [CLI documentation](CLIDocs.MD)

# Tests

- Tests can be run in root with `go test ./...` 

# API Documentation

- You can jump right into the [API Documentation](APIDocs.MD).

# Limitations

- Filters are done based on one field.

- Updates are done based only on username and game title.

- No authentication provided.