Skip to content

hongtatyew/where-is-hong

Repository files navigation

Where is Hong?

Welcome to the Where is Hong UI at whereishong.com read me! This project serves as a personal website designed to track Hong's whereabouts. Hong collaborated with his best friend, Michael Mortensen, who is responsible for the backend - Wish Journey. The UI is built using Docusaurus, providing an interactive and visually appealing display for Hong's journey.

Overview

The Where is Hong UI offers a glimpse into Hong's adventures, providing a visual representation of his current location and past experiences. This collaborative effort combines the frontend design with Michael's backend expertise, resulting in a seamless and engaging user experience.

Feel free to explore the documentation for insights into the project structure, customization options, and deployment procedures.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 14 or above)
  • Yarn

Installation

  1. Clone the repository:

    git clone https://github.com/gimlichael/wish-journey.git
  2. Navigate to the project directory:

    cd wish-journey
  3. Install dependencies:

    yarn install

Local Development

To run the Docusaurus server locally and preview the UI:

yarn start

Visit http://localhost:3000 in your browser to view the UI.

Usage

Explore the interactive UI to navigate through different sections of Hong's epic bike trip. Enjoy the photos, stories, and memories that have been captured during the journey.

Customization

Feel free to customize the content and appearance of the UI by editing the markdown files in the docs directory. Update the configuration in docusaurus.config.js to match preferences.

Deployment

When Hong is ready to share the epic bike trip with others:

yarn build
yarn deploy

This will build the static files and deploy them to whereishong.com.

License

This project is for personal use only and is not intended for redistribution or contributions.

Acknowledgments

Special thanks to Docusaurus for providing an easy-to-use documentation framework.


Happy biking and enjoy reminiscing about the epic journey!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published