luisnquin / blind-creator-rest-api-test

A somewhat simple REST API that I've made as my first project in the Blind Creator tech interview

Blind creator REST API test

Tools

Required

• go >=1.20
• git
• just
• docker
• docker-compose
• air (only for development)

Recommended

• golangci-lint
• panicparse
• pg-ping

Get started

• Ensure that you have all the required tools of the previous section

• Clone the project repository and stay in the root directory

  git clone https://github.com/luisnquin/blind-creator-rest-api-test.git /tmp/blind-creator-rest-api-test
  cd /tmp/blind-creator-rest-api-test

• Copy the .env.example file and rename it to .env, otherwise you'll not be able to do the next steps.

• You will need to create the database and migrate all the database tables with mock data, for that just execute:

  # Erases, starts and migrates the database
  $ just migrate

After that

• If is your first computer startup or if the services were killed then execute:

  # The docker compose services will need to be started
  $ just compose-up

• Just start the server:

  # Compiles and executes the server
  $ just start

• Start the server with live reload:

  # Uses `air` by behind to provide live-reload
  $ just dev

Requirements

• REST API(don't use frameworks)
• Use of GORM with PostgreSQL or MySQL
• Deployed in AWS Lambda or AWS EC2
• Must have a pagination endpoint with relationships.