Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.32 KB

README.md

File metadata and controls

91 lines (69 loc) · 2.32 KB
Raw

Octgopus

Trading platform API for submitting and matching orders. 🐙

Built with Golang and the Echo framework. Consumed by a React and Typescript app.

screenshot

Frontend

🎨 richo225/orderbook 🎨

Demo

⭐ octgopus.up.railway.app ⭐

Installation

To run the server, follow these steps:

  1. Ensure that Go is installed (version 1.16+ is recommended).
  2. Clone the repository:
  git clone https://github.com/richo225/octgopus.git
  1. Navigate to the project directory:
   cd octgopus

Setup

Copy the example .env.dist file in the project directory to .env and fill in the values:

  cp .env.dist .env
  PORT=<Port the server should run at> eg. 8080
  ALLOWED_ORIGINS=<Request source of the react app for CORS protection> eg. http://localhost:3000

Build

To build the application, run the following command in the project directory:

  make build

This will create an executable file in the cmd/api directory.

Run

Either run the generated executable via:

  ./cmd/api/api

Or simply combine the previous steps with:

  make run

Tests

To run the tests, use the following command:

  make test

This will run all tests in the project.