Water Footprint

Requirements

• Docker Compose

Getting Started

1. Start the development environment:

   docker compose up --build -d

2. Register the first administrator user: (Ensure Strapi is running)

   docker compose exec backend npm run strapi admin:create -- -f <Firstname> -e <Email> -p <Password>

3. Sync Strapi configurations: (Stored in the database)

   docker compose exec backend npm run config-sync import -- -y

Available Services

• Frontend (Next.js): http://localhost:3000
• Backend (Strapi): http://localhost:1337
• pgAdmin4: http://localhost:5050
• Mailpit: http://localhost:8025

Useful Commands

• Monitor container logs:

  docker compose logs -f <container_name>

• Stop the development environment:

  docker compose down

• Stop and clean up all data: (Use -v to remove volumes)

  docker compose down -v

Technical Notes

Strapi Configuration Sync

Background

Strapi stores configurations both in files and the database. Database-stored configurations need to be version-controlled and easily transferable between environments. This project uses the config-sync plugin for this purpose.

For more information, see the config-sync documentation.

User Interface

Access the config sync interface via the Strapi admin panel: Settings > Config Sync > Interface or directly at <BACKEND_URL>/admin/settings/config-sync.

Command Line

docker compose exec backend npm run config-sync help

Sync Workflow

During Development

• Import: After pulling changes from the repository, import the configuration to apply changes made by other developers.
• Export: After making configuration changes in the admin panel, export the configuration and commit it to Git. Submit a pull request (PR).

After Deployment

• Import: Immediately import the configuration after deployment. Ensure no configuration changes are made directly on the target server.
• Export and Download: After making configuration changes, export and download the configuration then commit it to the repository. The server configuration will be synced on the next deployment.

Using External Services

The project uses external services like an SMTP server sending emails.

For development efficiency, these external services are not required. The development server uses local services by default. To test integration with external services:

• Copy .env.example to .env.
• Set PLUGIN_PROVIDERS=external.
• Fill in the required SMTP service variables.
• Restart the development environment.