Contributing

We love contributions! Portabase is an open-source project, and we welcome help with the Dashboard, the Agent, and the CLI.

Whether you want to fix a bug, add a new feature, or improve the documentation, here is how you can get started with development for each component.

Dashboard development

Run the Dashboard from source:

git clone https://github.com/Portabase/portabase.git
cd portabase

pnpm install

cp .env.example .env

make up

Agent development

Set up the agent in a development environment:

git clone https://github.com/Portabase/agent.git
cd agent

cargo build

docker compose up

See the development requirements for the toolchain versions.

General Workflow

1. Fork the repository you want to contribute to.
2. Clone your fork locally.
3. Create a branch for your changes.
4. Commit your work with clear and concise messages.
5. Run the tests and make sure they pass, including the end-to-end tests where relevant (see Testing below).
6. Push to your fork and open a Pull Request.

Thank you for helping make Portabase better!

Testing

Portabase ships with an automated test pipeline that runs on every pull request.

The end-to-end (E2E) tests are maintained in a dedicated repository, Portabase/e2e-tests, rather than inside the main project repositories. Keeping them separate makes them easier to maintain and lets us reuse the same suite for agent-side testing.

Useful Development Commands

To make managing the development environment easier, make commands are available to handle authentication provider data.

make seed-auth

make seed-keycloak

make seed-pocket

make export-keycloak

make export-pocket

make pocket-token