Skip to content

App of provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan.

Notifications You must be signed in to change notification settings

miolab/weather_cast_angle

Repository files navigation

WeatherCastAngle

elixir ci workflow docker build workflow

Overview

This app is specifically designed to provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan. 🐟

Features

  • Screenshot during development;

    mobile
    screenshot_during_development
  • The information provided by this application;

    • Tide graph
    • Weather
    • Wind speed and direction
    • Temperature
    • Moon age
    • Humidity
    • Tide name (e.g. 大潮, 小潮, 長潮, etc.)
    • Seawater temperature
    • Sunrise and Sunset time

Source

Disclaimer

  • This repository and application are designed for personal use only.
  • The use of this app is at your own risk. We assume no liability for any outcomes resulting from its use.

Development information

Pre-required

Can build the Docker image and launch the application using the following commands:

  • Prepare .env file and set OpenWeather API key (required)

    cp .env.sample .env
  • Run mix git_hooks.install to prepare local development

  • Run mix setup to install and setup dependencies

Start this application using docker container

To start the Phoenix server,

  • Build the application container

    docker build -t weather_cast_angle .
    • For development, and if docker compose command is available, the following will work instead.

      docker compose build
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server using docker;

    docker run --rm -p 4000:4000 \
    -v $(pwd):/app \
    -e OPEN_WEATHER_API_KEY=$(cat .env | grep OPEN_WEATHER_API_KEY | cut -d '=' -f2) \
    --name weather_cast_angle \
    weather_cast_angle
    • For development, and if docker compose command is available, the following will work instead.

      docker compose up
  • If want to run iex -S mix;

    docker exec -it weather_cast_angle iex -S mix

Setting Up npm Execution Environment for Local Development

In local testing and development, an npm execution environment may be required for tasks such as installing JavaScript libraries (e.g., chart.js). The use of nodenv is recommended for preparing this environment.

To install nodenv, refer to the official installation guide: nodenv installation.

The Node.js version specified in the .node-version file can be installed locally by executing the following command:

nodenv install

This ensures the appropriate Node.js version is available for the development environment.

Other Phoenix Official References

Ready to run in production? Please check our deployment guides.

About

App of provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published