Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miolab/weather_cast_angle
App of provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan.
https://github.com/miolab/weather_cast_angle
cachex docker elixir phoenix tailwindcss
Last synced: 8 days ago
JSON representation
App of provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan.
- Host: GitHub
- URL: https://github.com/miolab/weather_cast_angle
- Owner: miolab
- Created: 2023-11-20T10:54:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-13T09:41:37.000Z (13 days ago)
- Last Synced: 2024-12-13T10:19:38.845Z (13 days ago)
- Topics: cachex, docker, elixir, phoenix, tailwindcss
- Language: Elixir
- Homepage:
- Size: 459 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WeatherCastAngle
## Overview
This app is specifically designed to provide comprehensive information on tide levels, wind, weather, and more to help a fishing plan. :fish:
## Features
- Screenshot during development;
- The information provided by this application;
- Tide graph
- Weather
- Wind speed
- Temperature
- Moon age
- Humidity
- Seawater temperature
- Sunrise and Sunset time
### Source
- Marine information: Japan Meteorological Agency https://www.jma.go.jp/jma/kishou/info/coment.html
- https://www.jma.go.jp/jma/menu/menureport.html
- Weather information: OpenWeather https://openweathermap.org/full-price
- Current weather data: https://openweathermap.org/current
- 5 day weather forecast: https://openweathermap.org/forecast5
- Moon information: calculate using PyEphem astronomy library for Python https://rhodesmill.org/pyephem/
### 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](https://openweathermap.org/) API key (required)
```sh
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
```sh
docker build -t weather_cast_angle .
```
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server` using docker;
```sh
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
```
- If want to run `iex -S mix`;
```sh
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](https://github.com/nodenv/nodenv#installation).
The Node.js version specified in the .node-version file can be installed locally by executing the following command:
```sh
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](https://hexdocs.pm/phoenix/deployment.html).
- Learn more
- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix