Getting Started #1 – Setup and Explore Dokploy #1
Description
Pre-requisites
- Install Node.js 20.16.0
- Install pnpm >= 9.5.0
- Install Docker Desktop
Objective
Familiarize yourself with Dokploy, its features, and the developer environment.
Steps to Complete
1. Explore Dokploy Documentation
Read the official docs and videos to understand the platform:
- Website: https://dokploy.com/
- Intro Videos: https://docs.dokploy.com/docs/core/videos
- Documentation: https://docs.dokploy.com/docs/core
Note: You don't need to follow along or execute anything in the videos; just watching them will help you better understand Dokploy.
2. Setup Development Environment
Run the following commands in your terminal:
git clone https://github.com/dokploy/dokploy.git
cd dokploy
pnpm install
cp apps/dokploy/.env.example apps/dokploy/.env3. Install Docker Desktop
If you haven't already, install Docker Desktop for your operating system. While you could install Docker directly in shell environments, Docker Desktop is recommended for development.
4. Install and Run Dokploy
Execute these commands:
pnpm run dokploy:setup
pnpm run server:script
pnpm run dokploy:devNote: These steps are from the [Contributing Guide](link-to-contributing-guide). If you encounter errors, check for outdated information or steps.
5. Access Dokploy UI and Create User
- Navigate to http://127.0.0.1:3000 in your browser
- Register with the following credentials:
- Username: admin
- Email: [your email address]
- Password: admin123
Note: If you previously set up a PostgreSQL database on your Dokploy instance, you may need to delete it first.
6. Explore the UI
Take time to navigate through the website and familiarize yourself with all available features.
7. Create Your First Project
In the Projects section, create a new project with:
- Name:
[YOUR-NAME]-hello-world(e.g.,John-Doe-hello-world) - Description: Share your current understanding of Dokploy and one thing you are most curious to learn about.
Submission Requirements
Upload a screen recording demonstrating:
- User creation process
- Project creation process
- Filling out project name and description
- Successfully creating the project
Tips
- Take time exploring the platform — understanding the UI now will make contributing easier later
- Don't hesitate to ask questions if you get stuck
- Document any issues you encounter for future improvements
Acceptance Criteria
- Successfully set up development environment
- Created user account in local Dokploy instance
- Created first project with proper naming convention
- Submitted screen recording showing all required steps
- Explored and understood basic Dokploy features
Download https://cap.so/ to record your screen (use Studio mode). Export as an mp4, and drag and drop into an issue comment below.