Skip to content

codex-storage/nim-codex

This branch is up to date with master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

962fc1c · Jan 24, 2025
Jan 21, 2025
May 23, 2024
Jan 24, 2025
Jan 9, 2025
Aug 23, 2022
Jan 21, 2025
Jan 24, 2025
Jan 21, 2025
Jan 24, 2025
Mar 8, 2023
Feb 2, 2021
Jan 22, 2025
Jan 21, 2025
Jan 21, 2025
Jan 21, 2025
Aug 19, 2024
Aug 13, 2024
Jan 21, 2025
Jan 21, 2025
Jan 9, 2025
May 19, 2022
Jan 10, 2025
Jun 17, 2024
Jan 10, 2025
Dec 20, 2021
Jan 10, 2025
Jan 21, 2025
Jan 24, 2025

Repository files navigation

Codex Decentralized Durability Engine

The Codex project aims to create a decentralized durability engine that allows persisting data in p2p networks. In other words, it allows storing files and data with predictable durability guarantees for later retrieval.

WARNING: This project is under active development and is considered pre-alpha.

License: Apache License: MIT Stability: experimental CI Docker Codecov Discord Docker Pulls

Build and Run

For detailed instructions on preparing to build nim-codex see Build Codex.

To build the project, clone it and run:

make update && make

The executable will be placed under the build directory under the project root.

Run the client with:

build/codex

Configuration

It is possible to configure a Codex node in several ways:

  1. CLI options
  2. Environment variables
  3. Configuration file

The order of priority is the same as above: CLI options --> Environment variables --> Configuration file.

Please check documentation for more information.

Guides

To get acquainted with Codex, consider:

API

The client exposes a REST API that can be used to interact with the clients. Overview of the API can be found on api.codex.storage.

Contributing and development

Feel free to dive in, contributions are welcomed! Open an issue or submit PRs.

Linting and formatting

nim-codex uses nph for formatting our code and it is requrired to adhere to its styling. If you are setting up fresh setup, in order to get nph run make build-nph. In order to format files run make nph/<file/folder you want to format>. If you want you can install Git pre-commit hook using make install-nph-commit, which will format modified files prior commiting them. If you are using VSCode and the NimLang extension you can enable "Format On Save" (eq. the nim.formatOnSave property) that will format the files using nph.