forc.pub

Welcome to the GitHub repository for forc.pub, the official package registry for the Sway programming language.

How it Works

forc.pub has a simple multi-threaded Rocket backend server which stores and fetches package metadata in a Postgres database. Packages are stored in a dedicated IPFS network, and package metadata is indexed and stored in forc.pub-index.

The frontend uses React and TypeScript.

Forc Documentation

For user documentation, including installing release builds, see: https://docs.fuel.network/docs/forc/.

Building from Source

This section is for local development of forc.pub.

Dependencies and Tools

forc.pub is built in Rust and TypeScript. To begin, install the Rust toolchain following instructions at https://www.rust-lang.org/tools/install. Then configure your Rust toolchain to use Rust stable:

rustup default stable

If not already done, add the Cargo bin directory to your PATH by adding the following line to ~/.profile and restarting the shell session.

export PATH="${HOME}/.cargo/bin:${PATH}"

You will also need to install Node.js.

To run the Postgres database locally, you will need Docker.

To connect to the database, you will need the Diesel CLI.

Diesel is the Rust ORM used to create and run database migrations. It requires a separate C library called libpq to be installed as well.

# Mac only
brew install libpq

# Ubuntu only
apt-get install libpq5

# Install diesel CLI
cargo install diesel_cli --no-default-features --features postgres

# On macOS-arm64, you may need additional rust flags:
RUSTFLAGS='-L /opt/homebrew/opt/libpq/lib' cargo install diesel_cli --no-default-features --features postgres

See docs/database.md for more information about working with the database.

Building the forc.pub server

Clone the repository and build the Sway toolchain:

git clone [email protected]:FuelLabs/forc.pub.git
cd forc.pub
cargo build

Confirm the server built successfully:

cargo run --bin forc.pub

Running the forc.pub server

Before starting the server, the local database must be up and running.

./scripts/start_local_db.sh

Next, set up the environment by copying .env.example to .env.local, and modifying .env.local with your Pinata test gateway details and Github App env (if testing github login functionality).

Now we can run the server with:

cargo run

Alternatively, the server can be run locally with Docker, as it is in the deployed environment.

./scripts/start_local_server.sh

# Force the server image to be rebuilt
./scripts/start_local_server.sh -f

Manually trigger the APIs

You can manually trigger the APIs with curl, for example:

curl -X POST "http://localhost:8080/upload_project?forc_version=0.66.5" \
  -H "Content-Type: application/gzip" \
  --data-binary "@tests/fixtures/sway-project.tgz"

Running the Frontend

The frontend requires npm and node to be installed.

cd app
npm i
npm start

This will open http://localhost:3000 in your browser. By default, it will use the local server endpoint, so the local server must be running.

Architecture diagram

flowchart TD
    subgraph "Frontend Layer"
        FE["React Frontend"]:::frontend
    end

    subgraph "Backend Layer"
        BE["Rocket Backend"]:::backend
        APIRoutes["API Routes"]:::backend
        Middleware["Middleware (CORS,Auth)"]:::middleware
        Handlers["Business Logic / Handlers"]:::handlers
    end

    subgraph "Database Layer"
        DB["Postgres Database"]:::database
    end

    subgraph "External Services"
        IPFS["IPFS/Pinata"]:::external
        GitHub["GitHub Auth"]:::external
    end

    subgraph "Deployment/CI-CD"
        CI["CI/CD Workflows"]:::deployment
        Docker["Docker Containerization"]:::deployment
        Helm["Kubernetes Helm Charts"]:::deployment
    end

    FE -->|"RESTAPICalls"| BE
    BE -->|"APIEndpoints"| APIRoutes
    APIRoutes -->|"UsesMiddleware"| Middleware
    Middleware -->|"ExecutesLogic"| Handlers
    Handlers -->|"DBOperations"| DB

    BE -->|"IPFSIntegration"| IPFS
    BE -->|"GitHubAuth"| GitHub

    CI -->|"TriggersContainerBuild"| Docker
    CI -->|"DeploysViaHelm"| Helm
    Docker -->|"DeploysBackend"| BE
    Helm -->|"OrchestratesBackend"| BE

    click FE "https://github.com/fuellabs/forc.pub/tree/master/app/"
    click BE "https://github.com/fuellabs/forc.pub/tree/master/src/"
    click DB "https://github.com/fuellabs/forc.pub/tree/master/migrations/"
    click IPFS "https://github.com/fuellabs/forc.pub/blob/master/src/pinata/mod.rs"
    click GitHub "https://github.com/fuellabs/forc.pub/blob/master/src/github.rs"
    click CI "https://github.com/fuellabs/forc.pub/tree/master/.github/workflows/"
    click Docker "https://github.com/fuellabs/forc.pub/tree/master/deployment/Dockerfile"
    click Helm "https://github.com/fuellabs/forc.pub/blob/master/helm/forc.pub"

    classDef middleware fill:#475569,stroke:#22d3ee,stroke-width:2px,color:#f8fafc;
    classDef handlers fill:#475569,stroke:#22d3ee,stroke-width:2px,color:#f8fafc;
    classDef frontend fill:#334155,stroke:#60a5fa,stroke-width:2px,color:#f8fafc;
    classDef backend fill:#475569,stroke:#22d3ee,stroke-width:2px,color:#f8fafc;
    classDef database fill:#334155,stroke:#fcd34d,stroke-width:2px,color:#f8fafc;
    classDef external fill:#1e293b,stroke:#f472b6,stroke-width:2px,color:#f8fafc;
    classDef deployment fill:#3f3f46,stroke:#fde047,stroke-width:2px,color:#f8fafc;

    linkStyle default stroke:#22d3ee,stroke-width:2px;

Loading

Contributing

We are not currently accepting contributions to forc.pub as the MVP is still being developed.