Skip to content

sulcer/databox-challenge

Repository files navigation

Databox Challenge

Features

  • Fetch Cryptocurrency Data: Fetch cryptocurrency data from Alpaca API
  • Fetch Stock Data: Fetch stock data from Alpha Vantage API
  • Send Data to Databox: Send data to Databox API
  • Send Custom Metrics to Databox: Send custom metrics to Databox

Technologies Used

  • Backend Framework: NestJS
  • Authentication: JWT and Github OAuth

Pre-requirements

  • Node.js 20+
  • Docker

Setup Instructions

1. Install dependencies

npm install

2. Setup environment variables

Create a .env and .env.test files in the root directory and add the following environment variables

NODE_ENV=development (or test)
PORT=3000
SWAGGER_PATH=/api-docs
CORS_ORIGIN=*
ALPACA_API_URL=https://data.alpaca.markets/v1beta3/crypto/us
ALPHA_VANTAGE_API_URL=https://www.alphavantage.co/query
ALPHA_VANTAGE_API_KEY=example
DATABOX_API_KEY=example
CLIENT_ID=example
CLIENT_SECRET=example
GITHUB_CALLBACK_URL=example
JWT_SECRET=example
JWT_EXPIRATION=example

3. Run the application

npm run start:dev

The application will be running on http://localhost:3000

About

Databox Backend Engineering Challenge

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published