dcsil / blockcomet-dev

A code repository for our blockchain company BlockComet

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

blockcomet-dev's Issues

Some workflows have no defined timeouts or are not using self-hosted

This repo has workflows that have no defined timeouts and/or are not using self-hosted.

We use self hosted runners to avoid overage costs associated with GitHub Actions. However, we don't have a lot of workers to handle all of the load.
To ensure a single build doesn't spend hours and monopolize our workers, we limit each job to 20 minutes.
Please add a timeout to your jobs. We will disable your actions until you add them.

Your build may also be missing self-hosted in the runs-on field.

Docs: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes
Example:

jobs:
  build:
    runs-on: self-hosted # This is required
    timeout-minutes: 20 # Add this line here

Affected Workflows:

Workflow Path	Job	Re-enable
.github/workflows/jest.yml	build	https://github.com/dcsil/blockcomet-dev/actions/workflows/jest.yml
.github/workflows/pytest.yml	test	https://github.com/dcsil/blockcomet-dev/actions/workflows/pytest.yml

Disabling GitHub Actions

Congratulations on finishing the course!

To make sure we have have workers for the next term, we have automatically disabled your repository's actions.

Feel free to make this repo public or fork to your own org, but we do ask that you leave a copy in the DCSIL org :)