Giter Club home page Giter Club logo

prepaidcard's Introduction

Prepaid Card

Build Status Coverage Status

This is a development exercise for building a prepaid card service written in Go.

Prerequisites

  • Docker
  • Git
  • GNU Make (optional) - Make is used for convenience as a shortcut to commands. If you prefer, you can always run the commands, which are listed in the Makefile.

Installation

Follow the steps to setup your development workspace:

  1. Clone the repository
    $ git clone [email protected]:sepetrov/prepaidcard.git ~/Projects/prepaidcard
  2. cd into the project directory
    $ cd ~/Projects/prepaidcard
  3. Create file with environment variables for Docker from the template .env.dist
    $ cp .env.dist .env
  4. Build and start the API containers
    • for testing and usage run
      $ make up
    • for development run
      $ make dev

The API should be accessible on the port number configured in .env, e.g. http://localhost:${API_PORT}.

API Specification

The OpenAPI Specification can be found in doc/openapi.yml.

To read the API specification and to test the API you can build and start the doc container.

$ make doc

This container will be accessible on the port number configured in your .env file as DOC_PORT, e.g. http://localhost:${DOC_PORT}.

prepaidcard's People

Contributors

sepetrov avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.