mirror of
https://github.com/DumbWareio/DumbDrop.git
synced 2026-02-19 23:52:36 +08:00
add svg to login / index for favicon ensure file sanitization before and during notification
DumbDrop Development Guide
Quick Start
-
Clone the repository:
git clone https://github.com/yourusername/DumbDrop.git cd DumbDrop -
Set up development environment:
cd dev cp .env.dev.example .env.dev -
Start development server:
docker-compose -f docker-compose.dev.yml up
The application will be available at http://localhost:3000 with hot-reloading enabled.
Development Environment Features
- Hot-reloading with nodemon
- Development-specific environment variables
- Local file storage in
../local_uploads - Debug logging enabled
- Development-specific notifications
Project Structure
DumbDrop/
├── dev/ # Development configurations
│ ├── docker-compose.dev.yml
│ ├── .env.dev.example
│ └── README.md
├── src/ # Application source code
├── public/ # Static assets
├── local_uploads/ # Development file storage
└── [Production files in root]
Development Workflow
-
Create feature branches from
main:git checkout -b feature/your-feature-name -
Make changes and test locally
-
Commit using conventional commits:
feat: add new feature fix: resolve bug docs: update documentation -
Push and create pull request
Debugging
- Use
DEBUG=dumbdrop:*for detailed logs - Container shell access:
docker-compose -f docker-compose.dev.yml exec app sh - Logs:
docker-compose -f docker-compose.dev.yml logs -f app
Common Issues
- Port conflicts: Change port in
.env.dev - File permissions: Ensure proper ownership of
local_uploads - Node modules: Remove and rebuild with
docker-compose -f docker-compose.dev.yml build --no-cache