Skip to content

Conversation

Copy link

Copilot AI commented Nov 16, 2025

Replace generic Next.js boilerplate README with BubblyMaps-specific documentation including clone/build/deploy workflows.

Changes

  • Project overview: Added BubblyMaps description with feature list (MapLibre GL, NextAuth, Prisma, MinIO integration)
  • Prerequisites: Node.js 20.x, Docker, PostgreSQL requirements
  • Manual setup: Complete workflow from git clone master branch through environment configuration, Prisma migrations, build, and deployment
  • Docker deployment:
    • Image build from master branch
    • Container run with environment variables
    • Docker Compose orchestration with lifecycle commands (up/down/rebuild/logs)
  • Development: Local dev server, linting, and database management commands
  • Project structure: Directory layout and technology stack overview

Example: Docker Deployment

# Build from master
docker build -t bubblymaps/web:latest .

# Deploy with compose
docker-compose up -d

# View logs
docker-compose logs -f web

Environment configuration moved from implicit to explicit with .ENV.EXAMPLE reference and complete variable documentation.

Original prompt

please update the readme to reflect my project. include how to manually clone and build from mastrr branch, and deploy the docker container that is built.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 16, 2025
Co-authored-by: linuskang <194789570+linuskang@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README with cloning and deployment instructions Update README with project-specific documentation and Docker deployment instructions Nov 16, 2025
Copilot AI requested a review from linuskang November 16, 2025 13:40
@github-actions github-actions bot added documentation Improvements or additions to documentation size/m labels Nov 16, 2025
@linuskang linuskang marked this pull request as ready for review November 16, 2025 20:45
@linuskang linuskang merged commit 472a913 into master Nov 16, 2025
7 checks passed
@linuskang linuskang deleted the copilot/update-readme-project-instructions branch November 17, 2025 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants