Welcome to Retkilyhty!

Retkilyhty is a versatile application that empowers users to easily discover and explore various types of accommodations and points of interest in their area. Whether you're planning a weekend escape, an adventure to a reserved hut, or just curious about nearby attractions, this app has you covered.

Note: This project is an ongoing work in progress. We're actively developing additional features and improvements. Feel free to star the repository to stay updated!

Table of Contents

• Features
• Technologies
• Installation
• Hosting
• infrastructure

Features

• View a dynamic map with markers representing a wide range of locations, including cabins, huts, reserved huts, on-shelter huts, attractions, and more.
• Click on a marker to access detailed information about a specific location. You can also check the current weather information for that area.
• Easily search for places by name.
• Ability for users to add new locations directly on the map.
• Locate nearest points of interest nearby with a single button press.
• Enjoy a responsive design for a seamless experience on various devices.

Technologies

TrailTorch is powered by the following technologies:

• React: A JavaScript library for crafting user interfaces.
• Node.js: A JavaScript runtime for server-side development.
• Koa: A minimalistic web framework for Node.js.
• Mapbox: A mapping platform offering location-based service APIs.
• Tailwind CSS: A utility-first CSS framework for quick and stylish app styling.
• Vite: A fast build tool for modern web applications.
• Recaptcha: A Google service for preventing spam and abuse on your site.
• Material UI: A popular React UI framework providing pre-built components for design.
• PostGIS: An extension for PostgreSQL that adds support for geographic objects, allowing location queries to be run in SQL.

Third-Party Data Sources

Retkilyhty leverages data from various sources, including the Tulikartta API, for location information, and it integrates with OpenWeatherMap for up-to-date weather details.

Installation

To use this app effectively, you'll need an OpenWeatherMap API key and a Mapbox API key. You also can have Recapcha key

1. Clone the repository.

2. Backend Setup:

   • Navigate to the backend directory.
   • Run the following Docker command to start the backend server and database:

 docker-compose -f docker-compose-prod.yml build

 docker-compose -f docker-compose-prod.yml up

• Ensure you have an env file containing PostgreSQL settings.

3. Frontend Setup:

   • Navigate to the frontend directory.

   • Create the Docker image for the frontend:

     docker build -t my-frontend-image -f dockerfile.frontend .

   • Start the frontend container:

     docker run -p 8000:8000 my-frontend-image

   • Ensure you have an env file in the frontend directory containing necessary configurations.

Hosting

TrailTorch is hosted on AWS, ensuring reliable performance and accessibility to users across the globe.

Infrastructure

Contributing

Contributions are highly encouraged! If you discover any issues or have suggestions for improvements, please don't hesitate to submit a pull request. Be sure to follow the code of conduct when contributing.

License

This project is licensed under the MIT License.