Skip to content

Directory Structure

Dmitri edited this page Aug 23, 2022 · 36 revisions
.cspell/ # custom dictionary of Frequency terms based on CSpell checker
.maintain/ # templates necessary to maintain the project (ex. generating weights)?
ci/ # CI related scripts
common/ # common things shared between pallets (ex. types, primitives, etc.)
designdocs/ # temporary docs mostly for alignment for the team and will be deleted as features being built and released
docs/images/ # images used in documentation 
js/api-augmeneted # RPC configurations for Frequency for use with Polkadot JS API
node/ # ?
  |_cli/ #
  |_service/ #
  |_src/ # 
pallets/ # custom pallets developed by Frequency team
res/ # short for "results", a collection of generated chain specs
  |_genesis/ # specific to first block
  |   |_local/ # Frequency + Rococo local chain spec, compiled WASM and state
  |   |_mainnet/ # Frequency + Polkadot mainnet chain spec, compiled WASM and state
  |   |_testnet/ # Frequency + Rococo testnet chain spec, compiled WASM and state
  |_rococo-local.json # chain spec for Rococo local relay chain, aka Rococo local testnet
runtime/ # supported runtimes
  |_frequency # - Frequency runtime for running against Polkadot relay chain (prod)
  |_frequency-local # Frequency runtime for running against Rococo local testnet (local dev)
  |_frequency-rococo # Frequency runtime for running against Rococo testnet (staging)
scripts/ # collection of general scripts for building and maintaining the project
target/ # output directory for compiled code 
Dockerfile # image with Frequency binary built from main branch
Makefile # recipe for running different tasks designed to build and manage project