Skip to content
Amadou-dotPublic

About

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

WorldWise Banner

🌍 WorldWise – Track Your Adventures Around the Globe

Live Preview

A world map application that tracks your footsteps into every city you can think of. Never forget your wonderful experiences, and show your friends how you have wandered the world.


✨ Features

  • 🗺️ Interactive World Map: Click anywhere on the map to add cities you've visited
  • 📍 Geolocation Support: Use your current location to quickly add nearby cities
  • 🏙️ City Management: Add, view, and delete cities with detailed information
  • 🌍 Country Overview: View all countries you've visited with flags and stats
  • 📝 Travel Notes: Add personal notes and memories for each city
  • 📅 Date Tracking: Keep track of when you visited each location
  • 🔐 User Authentication: Secure login system to protect your travel data
  • 💾 Local Storage: Your data persists between sessions

🛠 Tech Stack

🚀 Quick Start

Prerequisites

  • Node.js (version 18 or higher)
  • npm (version 8 or higher)

Installation

# Clone the repository
git clone https://github.com/Amadou-dot/worldwise.git
cd worldwise

# Install dependencies
npm install

Initialize & Run

# Start development server
npm run dev

Open http://localhost:5173 to view the application.

Additional Scripts

# Build for production
npm run build

# Preview production build
npm run preview

# Run linting
npm run lint

# Start mock API server (if needed for development)
npm run server

📁 Project Structure

worldwise/
├── public/              # Static assets
├── src/
│   ├── assets/         # Images and media files
│   ├── components/     # Reusable UI components
│   │   └── Buttons/    # Button components
│   ├── context/        # React context for state management
│   ├── data/           # Mock data and JSON files
│   ├── helpers/        # Utility functions
│   ├── hooks/          # Custom React hooks
│   ├── pages/          # Page components
│   ├── types/          # TypeScript type definitions
│   ├── App.tsx         # Main application component
│   └── main.tsx        # Application entry point
├── package.json        # Dependencies and scripts
└── vite.config.ts      # Vite configuration

🎮 How to Use

  1. Login: Start by logging into the application
  2. Explore the Map: Navigate around the interactive world map
  3. Add Cities: Click on any location to add a city you've visited
  4. Fill Details: Add the date of visit and personal notes
  5. View Your Journey: Check your cities list and countries overview
  6. Manage Data: Edit or delete entries as needed

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License.


Made by Amadou

About

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages