Public Pool's Web

A modern web application built with Ruby on Rails 8.0 and Bootstrap 5, featuring real-time updates with Hotwire and a responsive design.

WARNING

❗❗❗ If you change host and port of your pool, you need to restart the application in umbrel os. Otherwise, sidekiq will not see them. ❗❗❗

Known Issues

• 7 hour's graph sometimes doesn't render on first load

Requirements

• Ruby 3.x (see .ruby-version file for exact version)
• Node.js (see .node-version file for exact version)
• PostgreSQL
• Yarn package manager

Development Setup

1. Clone the repository

   git clone <repository-url>
   cd public-pool-web

2. Install dependencies

   bundle install
   yarn install

3. Environment configuration

   cp .env.example .env.development
   # Edit .env.development with your local settings

4. Database setup

   bin/rails db:prepare

5. Start the development server

   bin/dev

   The application will be available at http://localhost:3000

Key Features

• Modern Rails 8.0 architecture
• Real-time updates using Hotwire (Turbo and Stimulus)
• Bootstrap 5 for responsive UI
• PostgreSQL database
• Background job processing with Sidekiq
• Caching with Solid Cache
• WebSocket support with Solid Cable

Testing

Run the test suite with:

   bin/rails test

Deployment

This application is set to be deployed manually on Umbrel OS (see umbrel-os directory). To deploy:

1. Clone the repository

   git clone https://github.com/martinbarilik/public-pool-web
   cd public-pool-web

2. rsync the application to the Umbrel OS server:

   rsync -av --exclude=".gitkeep" <path-to-your-cloned-repo-on-local-machine>/public-pool-web/umbrel-os umbrel@umbrel.local:/home/umbrel/umbrel/app-stores/getumbrel-umbrel-apps-github-53f74447/

3. Install the app on your umbrelOS device via terminal or app store

   umbreld client apps.install.mutate --appId public-pool-web

4. Uninstall the app

   umbreld client apps.uninstall.mutate --appId public-pool-web

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details

Docker Development

Additional Requirements

• Docker Engine
• Docker Buildx (for multi-platform builds)

Useful Commands

1. Run locally from docker-compose.yml

   debian@debian:~$ cd umbrel-os
   debian@debian:~$ source exports.sh && docker compose up

2. Access PostgreSQL Database

   debian@debian:~$ docker exec -it <container-id> psql -U <user> -d <dbname>

3. Access Rails Console

   debian@debian:~$ docker exec -it <container-id> ./bin/rails c

4. Build and Push Multi-Platform Image

   # Login to Docker Hub
   debian@debian:~$ docker login
   
   # Set up buildx for multi-platform builds
   debian@debian:~$ docker buildx create --use
   
   # Build and push for multiple architectures
   debian@debian:~$ docker buildx build --push \
    --platform linux/arm64,linux/amd64 \
    -t martinbarilik/public-pool-web:0.0.7 \
    -t martinbarilik/public-pool-web:latest .

Note: Replace <container-id> with your actual Docker container ID. You can find it using docker ps.