An open API service indexing awesome lists of open source software.

https://github.com/cletqui/tide

Dive into Tide Clock: Catch the Wave of French Harbor Tides! πŸŒŠπŸ•°οΈ
https://github.com/cletqui/tide

analog-clock clock cloudflare cloudflare-pages github-pages tide

Last synced: 3 months ago
JSON representation

Dive into Tide Clock: Catch the Wave of French Harbor Tides! πŸŒŠπŸ•°οΈ

Awesome Lists containing this project

README

          

# 🌊 Tide Clock πŸ•‘

You don't know when it's time for the next tide? Look for the next tide with **Tide Clock**.

## Description

Welcome to the Tide Clock application! This minimalist clock allows users to check the high and low tide information for harbors and cities in France.

## Table of Contents

- [🌊 Tide Clock πŸ•‘](#-tide-clock-)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Website URLs](#website-urls)
- [Features](#features)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Feedback](#feedback)
- [Project Status](#project-status)

## Website URLs

You can access the website at the following URLs:

- [Tide Clock - GitHub Pages](https://cletqui.github.io/tide)
- [Tide Clock - Cloudflare Pages](https://tide.pages.dev)

[![pages-build-deployment](https://github.com/cletqui/tide/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/cletqui/tide/actions/workflows/pages/pages-build-deployment)

Feel free to visit and explore the website!

## Features

πŸ•‘ **Clock:** Display tide time on a modern and minimalistic clock.

πŸ”Ž **Search:** Use the search bar to find information about tides in specific French harbors or cities.

πŸ“ **Geolocation:** Automatically detect the user's location or manually input a location to check the tide status.

πŸ—ΊοΈ **Nearest Harbors:** Receive a list of nearest French harbors based on your search query.

πŸ“± **Responsive Design:** The application is designed to work seamlessly on various devices.

## Roadmap

- [x] Implement search functionality (dropdown selection, nearest harbour)

- [ ] Implement more efficient localStorage usage with tideData

- [ ] Responsive design for mobile

- [ ] Geolocate the user to use the nearest harbour

- [ ] Display more data on screen (tide high, coeff, current tide status, next high or low tide time, tide height, and tide trend.)

- [ ] Handle errors graphically

- [ ] Add options in website header

## Contributing

If you would like to contribute to the development of the Tide Clock application, please follow our contribution guidelines.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

Tide Clock uses a custom personal API providing with the latest tide information.

## Feedback

We welcome your feedback! If you encounter any issues or have suggestions for improvement, please open an [issue](https://github.com/cletqui/tide/issues).

## Project Status

This project is actively maintained and open to contributions.