Code Monkey home page Code Monkey logo

backend-engineer-assessment's Introduction

Getting Started

IMPORTANT: Do not send pull requests to this repository. This is a template repository and is not used for grading. Any pull requests will be closed and ignored.

Introduction

If you are reading this, you are probably have received this project as a coding challenge. Please read the instructions carefully and follow the steps below to get started.

Setup

Pre-requisities

To run the application you would require:

On macOS:

First, you need to install Java 21 or later. You can download it from Azul or use SDKMAN.

brew install --cask zulu21

You can install Temporal using Homebrew

brew install temporal

or visit Temporal Installation for more information.

You can install Docker using Homebrew

brew install docker

or visit Docker Installation for more information.

Other platforms

Please check the official documentation for the installation of Java, Temporal, and Docker for your platform.

Stripe API Keys

Sign up for a Stripe account and get your API keys from the Stripe Dashboard. Then in application.properties file add the following line with your secret key.

stripe.api-key=sk_test_51J3j

Run

You are required to first start the temporal server using the following command

temporal server start-dev

and then run the application using the following command or using your IDE.

./gradlew bootRun

Other commands

Lint

To run lint checks, use the following command

./gradlew sonarlintMain

Code Formatting

To format the code, use the following command

./gradlew spotlessApply

Guides

The following guides illustrate how to use some features concretely:

Docker Compose support

This project contains a Docker Compose file named compose.yaml. In this file, the following services have been defined:

Please review the tags of the used images and set them to the same as you're running in production.

backend-engineer-assessment's People

Contributors

onlywicked 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.