Public/traveltracer

Fork 0

mirror of https://github.com/zebrajr/traveltracer.git synced 2025-12-05 12:20:26 +01:00

Carlos Sousa da20b54f93

React CI Pipeline / build-and-test (push) Has been cancelled

Details

improve project README

2025-06-30 15:07:08 +02:00

2.6 KiB

Raw Permalink Blame History

Travel Tracer 🌍✈️

Overview

Travel Tracer is an interactive web application that allows users to visualize and share their travel experiences by marking visited locations and dream destinations on an interactive world map.

Live Demo: travel.carlossousa.tech

Features

🗺️ Interactive world map using Leaflet
📍 Mark visited countries and future travel destinations
📸 Potential for adding travel photos and notes
🌐 Responsive design
🐳 Docker support for easy deployment

Technologies Used

React
Leaflet
JSON for data management
Docker
Docker Compose

Prerequisites

Node.js (v18 or later)
Docker (optional, for containerized deployment)

Local Development Setup

Manual Setup

Clone the repository

git clone https://github.com/zebrajr/traveltracer.git
cd travel-tracer/frontend

Install dependencies
```
npm install
```
Start the development server
```
npm start
```

Docker Development Setup

Ensure Docker and Docker Compose are installed
Start development environment
```
docker-compose up dev
```

Production Deployment

Docker Deployment

Build and run production container
```
docker-compose up traveltracer
```

Note: you can force rebuild if needed with docker-compose build traveltracer

Project Structure

travel-tracer/
│
├── frontend/             # Main application directory
│   ├── src/              # Source code
│   ├── public/           # Public assets
│   └── package.json      # npm dependencies
│
├── Dockerfile            # Production Docker configuration
└── docker-compose.yml    # Docker Compose configuration

Customization

Edit JSON files in frontend/public/lists/ to update travel locations
Modify map styles and configurations in relevant components

Future Roadmap

Add user authentication
Implement Simple GUI to add New Visited / Wishlisted Locations
Implement photo upload feature
Create shareable travel maps

Contributing

Fork the repository
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: github.com/zebrajr/traveltracer Live Demo: travel.carlossousa.tech

2.6 KiB Raw Permalink Blame History