Skip to content

Latest commit

 

History

History
191 lines (143 loc) · 5.38 KB

README.md

File metadata and controls

191 lines (143 loc) · 5.38 KB
Raw

Logo

Loyalty Card

Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Contact

About The Project

REST application for loyalty card management.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Hiring a kubernetes cluster:

  • Kubectl

  • Create a secrets: see "k8s/instructions.md"

Deploy

  • kubectl apply -f ./k8s

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Prerequisites:

  • Golang

    wget https://golang.org/dl/go1.18.linux-amd64.tar.gz
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

  • Docker and docker-compose

    sudo apt-get install docker docker-compose docker.io -y

  • Environment: see ".env.example"

Installation:

  1. Clone the repo

    git clone https://github.com/patricksferraz/loyalty-card.git

  2. Run

    make up

  3. Test

    make gtest

Installation in local kubernetes:

  1. Install k3d, Kind or similar
  2. Install Kubectl and Helm
  3. Follow the steps of Getting Started

    • Connect to cluster and run:

      kubectl apply -f k8s/

Contact

patricksferraz - patrick.ferraz@outlook.com

Project Link: loyalty-card