https://github.com/fuellabs/forc.pub

Website for discovering Sway packages and Forc plugins
https://github.com/fuellabs/forc.pub

Last synced: 8 months ago
JSON representation

Website for discovering Sway packages and Forc plugins

Host: GitHub
URL: https://github.com/fuellabs/forc.pub
Owner: FuelLabs
License: apache-2.0
Created: 2024-03-20T16:46:23.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2025-10-02T05:05:19.000Z (8 months ago)
Last Synced: 2025-10-02T07:08:55.312Z (8 months ago)
Language: Rust
Homepage: https://forc-pub.vercel.app
Size: 15.5 MB
Stars: 2
Watchers: 5
Forks: 3
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# forc.pub

[![docs](https://docs.rs/forc/badge.svg)](https://docs.rs/forc/)
[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)

Welcome to the GitHub repository for [forc.pub](https://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](https://github.com/FuelLabs/forc.pub-index).

The frontend uses React and TypeScript.

## Forc Documentation

For user documentation, including installing release builds, see: .

## 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 . Then configure your Rust toolchain to use Rust `stable`:

```sh
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.

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

You will also need to install [Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs).

To run the application locally, you will need [Docker](https://docs.docker.com/engine/install/) with Docker Compose.

To connect to the database for development, you may optionally install the [Diesel CLI](https://diesel.rs/guides/getting-started).

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.

```sh
# Mac
brew install libpq
# or Ubuntu/Debian
apt-get install libpq5

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

# Install cargo-binstall
cargo install cargo-binstall

# 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](database.md) for more information about working with the database.

### Building the `forc.pub` server

Clone the repository and build the Sway toolchain:

```sh
git clone git@github.com:FuelLabs/forc.pub.git
cd forc.pub
cargo build
```

Confirm the server built successfully:

```sh
cargo run --bin forc.pub
```

### Running the `forc.pub` server

The easiest way to run the complete application stack locally is using Docker Compose, which will start the database, backend server, and pgAdmin interface.

First, set up the environment by creating a `.env.local` file with your configuration. You'll need to add your Pinata test gateway details and Github App env (if testing github login functionality).

Now start all services with:

```sh
./scripts/start-local-server.sh
```

This will start:
- **PostgreSQL database** on port `${POSTGRES_PORT:-5432}`
- **Backend server** on port `8080`
- **pgAdmin** (database admin UI) on port `${PGADMIN_PORT:-5050}`

You can access:
- Backend API: http://localhost:8080
- pgAdmin interface: http://localhost:5050

**Database Access**: When connecting to the database server through pgAdmin, use password in `.env.local` (default: `localpw`).

To force rebuild the application image:

```sh
./scripts/start-local-server.sh -f
```

To view logs:

```sh
docker compose logs -f
```

To stop all services:

```sh
docker compose down
```

### Alternative: Running components separately

If you prefer to run components separately for development:

1. Start just the database and pgAdmin:
```sh
docker compose up -d db pgadmin
```

2. Run the backend server locally:
```sh
cargo run
```

### Manually trigger the APIs

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

```bash
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.

```sh
cd app
npm i
npm run build
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

```mermaid
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

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

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;
```

## Contributing

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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/fuellabs/forc.pub

Awesome Lists containing this project

README