docs(CONTRIBUTING.md): add contributing guidelines to assist new contributors

chore(.gitignore): update to ignore environment files and OS-specific files

build(docker-compose.yml): use environment variables for Grafana configuration to enhance flexibility

build(docker-compose.yml): add healthcheck and resource constraints for better container management

Author: vergissberlin

.env

@@ -6,4 +6,3 @@ GF_SECURITY_ADMIN_USER=yourusername
 GF_SECURITY_ADMIN_PASSWORD=yourpassword
 GF_INSTALL_PLUGINS=grafana-piechart-panel,grafana-worldmap-panel,grafana-clock-panel,grafana-simple-json-datasource
 GF_LOG_MODE=console
-

.gitignore

@@ -2,8 +2,26 @@
 
 !/.env
 !/.gitignore
+!/CONTRIBUTING.md
 !/docker-compose.yml
 !/Dockerfile
 !/LICENSE
 !/railwayapp-grafana.png
 !/README.md
+
+# Environment variables
+.env
+
+# Grafana data
+data/grafana/*
+data/plugins/*
+data/backup/*
+
+# Keep directory structure
+!data/grafana/.gitkeep
+!data/plugins/.gitkeep
+!data/backup/.gitkeep
+
+# OS files
+.DS_Store
+Thumbs.db

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing Guidelines for Railway Grafana Template
+
+Thank you for your interest in contributing to this project! These guidelines will help you contribute effectively.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/railwayapp-grafana.git
+   cd railwayapp-grafana
+   ```
+3. Create a new branch:
+   ```bash
+   git checkout -b feature/your-feature
+   ```
+
+## Development Environment
+
+1. Copy the `.env.example` file:
+   ```bash
+   cp .env.example .env
+   ```
+2. Adjust the values in the `.env` file
+3. Start the development environment:
+   ```bash
+   docker-compose up -d
+   ```
+
+## Pull Request Guidelines
+
+1. Ensure your code follows the existing style
+2. Add tests when implementing new features
+3. Update documentation when necessary
+4. Describe your changes in the pull request
+
+## Commit Messages
+
+Use meaningful commit messages. A good format is:
+
+```
+feat: Add new feature
+fix: Fix bug in X
+docs: Update documentation
+style: Improve code formatting
+refactor: Restructure code
+```
+
+## Code Style
+
+- Use meaningful variable names
+- Comment complex logic
+- Keep functions short and focused
+- Follow Docker best practices
+
+## Testing
+
+1. Ensure all tests pass successfully
+2. Add new tests for new features
+3. Test your changes locally before committing
+
+## Documentation
+
+- Update README.md for relevant changes
+- Document new features
+- Add comments to complex code
+
+## Questions and Support
+
+For questions or issues:
+1. Check the existing documentation
+2. Create an issue in the GitHub repository
+3. Describe the problem in detail
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
+
+Thank you for your contributions! 

docker-compose.yml

@@ -9,15 +9,32 @@ services:
     restart: unless-stopped
     environment:
       - TZ=Europe/Amsterdam
-      - GF_DEFAULT_INSTANCE_NAME=my-instance
-      - GF_SECURITY_ADMIN_USER=owner
+      - GF_DEFAULT_INSTANCE_NAME=${GF_DEFAULT_INSTANCE_NAME}
+      - GF_SECURITY_ADMIN_USER=${GF_SECURITY_ADMIN_USER}
+      - GF_SECURITY_ADMIN_PASSWORD=${GF_SECURITY_ADMIN_PASSWORD}
       - GF_LOG_MODE=console
+      - GF_INSTALL_PLUGINS=grafana-clock-panel,grafana-simple-json-datasource
     ports:
       - 3000:3000
     volumes:
       - ./data/grafana:/var/lib/grafana
+      - ./data/plugins:/var/lib/grafana/plugins
+      - ./data/backup:/var/lib/grafana/backup
     networks:
       - regenfass
+    healthcheck:
+      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:3000/api/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 1G
+        reservations:
+          cpus: '0.5'
+          memory: 512M
 
 networks:
   regenfass: