Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.16 KB

README.md

File metadata and controls

39 lines (23 loc) · 1.16 KB
Raw

Cardcheck API

Go Report Card

This is an API for validating credit cards.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Go version 1.22.0
  • Docker (optional)

Installing

A step by step series of examples that tell you how to get a development environment running.

  1. Clone the repository
  2. Install the dependencies with go mod download
  3. Create .env file and copy values from .env_example
  4. Follow the instructions to install Taskfile utility
  5. Run the server with task run

Running the tests

  1. Run the tests with task test
  2. Also you can proceed with the OpenAPI docs by link localhost:8888/swagger

Deployment

You can also run the service in Docker container with task run-container

Built With

  • Go - The programming language used.
  • Docker - Used for containerization.