BlockComet Backend

BlockComet Developer's Guide

Setup Instructions

Prerequisites

Instructions for Mac, Windows, Linux

• Docker
• Git

Installation and Usage (Local Development)

1. Clone this repository

git clone https://github.com/dcsil/blockcomet-dev

2. Run bin/bootstrap (Ensure you are in the root folder)

This should install the languages & backend dependencies

./bin/bootstrap

3. Run the following commands:

cd server
poetry shell

Then, run:

poetry install
poetry run uvicorn server.main:app --host 0.0.0.0 --port 8080

4. (Optional) To setup docker container for the server, run the following command (from the server directory):

./setup_server.sh

Container should now be running on http://localhost:5001/

(Optional) Running tests

For all backend tests (From root folder):

./bin/test

For all backend tests with coverage stats (From root folder):

./bin/test_coverage

Resources

BlockComet - Google Drive