Skip to content
Dashboard
DocsGetting started

Start from a template

Take ownership of a complete starter application, customize it, and deploy from your own repository.

Browse the gallery by purpose: portfolio, website, API, or bot. Read the template details before deploying, especially the required accounts, environment variables, workload type, and storage requirements.

Each starter is independently usable. Its folder contains source, dependency lockfiles, a Dockerfile, deplexo.yaml, and a README. The README covers the application; these docs explain the shared Deplexo runtime.

Clone the public examples repository and run the export script with a template ID and a new destination directory. The exporter copies the selected starter with its license, so the result can become an independent repository.

Use a destination that does not already contain a project. The example below exports the Next.js portfolio. Other IDs include nextjs-website, go-telegram-bot, go-discord-bot, go-http-api, node-express, python-fastapi, and static-site.

Terminal window
git clone https://github.com/Deplexo/examples.git
cd examples
node scripts/export.mjs nextjs-portfolio ../my-portfolio
cd ../my-portfolio

Create a repository in your own git account and push the exported application there. Keep the license and required notices in your copy. Record the template revision you started from when tracking upstream changes.

Your repository controls when code and dependencies change. Avoid pointing a production deployment at the shared examples collection: its maintenance updates should not become your releases automatically.

Terminal window
git init
git add .
git commit -m "Start application"
git branch -M main
git remote add origin <your-repository-url>
git push -u origin main

Follow the starter README to install dependencies and run locally. Replace branding, profile content, links, and contact details. Keep .env.example as a list of configuration names with safe placeholders; store actual local credentials in an ignored file.

For bots, create a separate development bot if possible. Stop any local polling or Gateway instance using the production token before starting the deployed application.

Connect your repository in Deplexo and follow the quickstart. Preserve the starter’s Dockerfile and service type unless you deliberately change the runtime. Enter required credentials before deployment, then verify the app with a real interaction.

Updates to the examples repository do not automatically modify your copy. Review upstream improvements, dependency updates, and security fixes, then commit the changes you want to ship. Run the starter’s checks before redeploying.