Skip to content

stelofinance/stelofinance

Repository files navigation

Stelo Finance, the leading finance platform of BitCraft

  • Store in-game assets or derivation of such in digital accounts
  • Transact with any other player, anytime, no matter where in-game they are (if they even are in-game)
  • Build financial applications and tools on top!

API Documentation

For API documentation, see here

Development

  1. Use the Nix Flake shell
  2. Run task live. This will create a hot-reloading dev environment

DB

Currently using sqlite, but want to switch to Turso for the db once it's more stable/supported.

Migrations are done with Goose. Migrations are in database/migrations/*.

Queries are handled with SQLC. Queries are located in database/queries/*

NATS (& JetStream)

During development, JetStream data is stored in tmp/js.

Environment Secrets

The required ENV secrets are stored in .env at the project root, and are as follows:

  • ENV: "dev" or "prod"
  • PORT: Port for the web server to run on, such as "8080"
  • JS_DIR: Directory to store JetStream data
  • GOOSE_DRIVER: "sqlite3"
  • GOOSE_DBSTRING: DB connection URI string (ex ./tmp/dev.db)
  • GOOSE_MIGRATION_DIR: "./database/migrations"
  • DB_FILE: Same as GOOSE_DBSTRING, the DB file location
  • ADMIN_KEY: This is an admin key that can be used to make admin API requests

About

The main repo for the Stelo Finance platform, and it's core functionality.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors