Git Product home page Git Product logo

worldwise's Introduction

WorldWise

WorldWise is a React application that allows users to explore cities from around the world. It provides information about various cities, including their locations on a map, details about each city, and the ability to create and delete cities.

Screenshots

image image

Features

  • View a list of cities and their locations on a map.
  • Click on a city marker to see detailed information about the city.
  • Create a new city by providing its details.
  • Delete a city from the list.

Prerequisites

Before running the WorldWise application, ensure you have the following dependencies installed:

Installation

  1. Clone the repository:
git clone https://github.com/Ventorix/WorldWise.git
  1. Change into the project directory:
cd WorldWise
  1. Install the dependencies:
npm install

Configuration

The WorldWise application uses a JSON server to provide city data. By default, the server is configured to run on http://localhost:8000. If you need to change the server URL, modify the BASE_URL constant in the CitiesContext component located in src/contexts/CitiesContext.jsx.

Usage

  1. Start the JSON server to serve the city data:
npm run server
  1. Start the development server:
npm run dev
  1. Open your browser and navigate to http://localhost:3000 to access the WorldWise application.

Authentication

The WorldWise application includes authentication functionality. You can log in using the following credentials:

Available Scripts

In the project directory, you can run the following scripts:

  • npm run dev: Starts the development server.
  • npm run build: Builds the application for production.
  • npm run preview: Serves the production build locally for preview.
  • npm run server: Starts the JSON server to serve city data.

Contributing

Contributions are welcome! Feel free to open issues and submit pull requests to help improve the WorldWise application.

Acknowledgements

The WorldWise application uses the following open-source libraries:

Thank you for using WorldWise!

worldwise's People

Contributors

ventorix avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.