🚀 Quick Start

📋 Prerequisites

🛠️ Setup Guide - Windows PowerShell

1. Install WSL

wsl--install

Note

If WSL is already installed, update it instead:

wsl--update

You will be prompted to restart your PC after installation.

2. Install Docker Desktop

winget install--id Docker.DockerDesktop-e--source winget

Important

After installation:

• Restart your computer
• Launch Docker Desktop from the Start menu
• Ensure Docker Desktop is running (check system tray)
• Enable WSL 2 integration in Docker settings

3. Install Git

winget install--id Git.Git-e--source winget

Tip

Restart PowerShell after installation to refresh the PATH.

4. Clone the Repository

git clone https://github.com/giannicharles/hydropal.git

Note

This will create ahydropal folder in your current directory. Usecd to navigate to your preferred location first if needed.

5. Navigate to Project Directory

cd hydropal

6. Create Environment Files

VITE_API_URL=http://localhost:5000

MONGO_URI=mongodb://mongodb:27017/hydropal-dbJWT_SECRET=your_strong_secret_hereJWT_EXPIRE=30dFRONTEND_URL=http://localhost:3000NODE_ENV=development

Important

Security Recommendation: ChangeJWT_SECRET to a stronger, unique value:

JWT_SECRET=hydropal_strong_secret_key_2025_custom

Warning

Create these files manually using a text editor. PowerShell commands may cause encoding issues that prevent the database from working properly.

Note

These .env files are excluded from version control via.gitignore to protect configuration data.

7. Build and Start the Application

docker compose up-d

Note

Initial build may take several minutes. Once complete:

• Frontend:http://localhost:3000
• Backend API:http://localhost:5000/api

🐳 Docker Commands Reference

Basic Operations

Development Commands

# Rebuild and restart (useful during development)docker compose down && docker compose up-d--build# View running containersdocker ps# View all containers (including stopped)docker ps-a

Container Management

# Access container shelldocker exec-it<container_name>/bin/bash# View specific container logsdocker logs<container_name>-f# View container resource usagedocker stats

Database Operations

# Connect to MongoDBdocker exec-it hydropal-mongodb-1 mongosh# Inside MongoDB shelluse hydropal-dbshow collectionsdb.<collection_name>.find().pretty()

🔧 Troubleshooting

Common Issues

Getting Help

# Check Docker versiondocker--version# Check running servicesdocker compose ps# View system informationdocker system info

📁 Project Structure

hydropal/├── docker-compose.yml├── frontend/├── backend/└── README.md

🤝 Contributing

📄 License