Skip to main content
This guide walks you through deploying your first project on Pxxl. By the end you will have a live URL you can share — no servers to configure and no infrastructure to manage. The whole process takes under five minutes.
Before you begin, make sure you have:
  • A GitHub account with the repository you want to deploy.
  • A Pxxl account — sign up for free at pxxl.app/signup.
1

Create Your Account

Go to pxxl.app/signup and create your free Pxxl account. You can sign up with GitHub for the fastest setup — this also pre-authorises repository access in one click.
2

Connect GitHub

After you log in, open Dashboard → Settings → GitHub and click Connect GitHub Account. Grant Pxxl access to either all repositories or only the specific repos you want to deploy. You can update these permissions at any time from your GitHub settings.
3

Create a Project

Navigate to Dashboard → Deploy and click Deploy Project. Pxxl displays the repositories your GitHub account has authorised. Select the repository you want to deploy and continue to the configuration form.
4

Configure Build Settings

Fill in the deploy form fields for your project:
FieldDescription
Project DomainThe subdomain prefix for your pxxl.pro URL, e.g. my-api → my-api.pxxl.pro.
Port NumberThe port your application listens on inside the container. Must match the PORT value your code uses.
GitHub BranchThe branch Pxxl deploys from, e.g. main or production.
Environment VariablesKey-value pairs injected at runtime — database URLs, API keys, feature flags, and any other secrets.
Additional Build SettingsOverride the auto-detected install, build, and start commands, or set a Base Directory for monorepos.
Pxxl auto-detects your stack from lock files and pre-fills the command fields. Review them and adjust if your project has a non-standard setup.
5

Deploy

Click Deploy Project. Pxxl clones your repository, runs your install and build commands inside a fresh container, and then starts your application. Watch the build log stream in real time on the Deployments tab — a green status badge confirms a successful deployment.
6

Go Live

Your project is now live at yourproject.pxxl.pro. Click the URL in the dashboard to open it in your browser. Every subsequent push to your configured branch triggers an automatic redeploy.
Always use the PORT environment variable for the port your server listens on. Pxxl injects PORT automatically, so hard-coding a port number can cause your container to fail the health check. For example, in Node.js: const port = process.env.PORT || 3000;

​
Next Steps

Now that your first project is live, explore the rest of the Pxxl platform:
  • Custom Domains — point your own domain at your project from Dashboard → Domains.
  • Databases — provision a managed PostgreSQL instance from Dashboard → Database and connect it with an environment variable.
  • Deployment Reference — review exact install, build, and start commands for every supported stack in the Deployment Command Reference.
  • Framework Recipes — grab copy-paste configurations for your specific framework in the Framework Recipes guide.