Skip to content

Latest commit

 

History

History
187 lines (116 loc) · 6.56 KB

README.md

File metadata and controls

187 lines (116 loc) · 6.56 KB
Raw

TimeWarp

Understanding history, embracing the present, and envisioning the future

View Demo


Time Wrap is an open-source web application that enables users to explore historical versions of their current location virtually. By leveraging augmented reality and historical maps, users can visualize how their surroundings appeared in different time periods and delve into the area's rich history.

Features

  • Simulations: Step into pivotal moments in history through immersive simulations.

  • Historical Reenactments: Experience the sights and sounds of bygone eras through interactive reenactments.

  • Futuristic Scenarios: Peer into potential futures with speculative scenarios and advanced technologies.

With Time Wrap, the past, present, and future converge in a captivating journey through time, inviting users to explore, learn, and imagine the possibilities.

Tech Stack

Time Wrap utilizes the following technologies:

  • HTML: Provides the structure for web pages.
  • CSS: Styles the appearance of web pages, ensuring a visually appealing user experience.
  • JavaScript: Adds interactivity and functionality to the web application.
  • Three.js: A JavaScript library used for creating and displaying 3D content in web browsers.
  • React.js: A JavaScript library for building user interfaces, enabling efficient development of dynamic and interactive web applications.
  • Virtual Reality: Integration of virtual reality technology to create immersive experiences.
  • Augmented Reality Applications: Implementation of augmented reality technology to enhance user interactions and provide innovative features such as exploring historical environments and visualizing past landscapes in real-time.

React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

👇 Prerequisites

Before installation, please ensure you have the following tools installed:

  • Git - Learn Git step-by-step by following the instructions provided here.

How to Contribute

If you think that you can add a new feature or want to fix a bug, we invite you to contribute to Timewarp and make this project better. To contribute:

  1. Create a folder at your desire location (usually at your desktop).

  2. Open Git Bash Here

  3. Create a Git repository.

    Run command git init

  4. Fork the repository.

  5. Clone your forked repository of project.

git clone https://github.com/<your_username>/TimeWarp.git
  1. Navigate to the project directory.
cd TimeWarp
  1. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/Akshatchaube01/TimeWarp.git
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
git pull upstream main
  1. Create a new branch(prefer a branch name that relates to your assigned issue).
git checkout -b <YOUR_BRANCH_NAME>

  1. Perform your desired changes to the code base.

  2. Check your changes.

git status

git  diff
  1. Stage your changes.
git add . <\files_that_you_made_changes>
  1. Commit your changes.
git commit -m "relavant message"
  1. Push the committed changes in your feature branch to your remote repository.
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests.

  2. Add an appropriate title and description to your PR explaining your changes.

  3. Click on Create pull request.

Alternative Way

Follow the below instructions you can use GitHub Desktop to manage this repository. Here's how:

  1. Download and Install GitHub Desktop:

    • Go to the GitHub Desktop website and download the GitHub Desktop application.
    • Follow the installation instructions to install GitHub Desktop on your computer.

  2. Clone the Repository:

    • Open GitHub Desktop and sign in to your GitHub account.
    • Click on the "File" menu, then select "Clone Repository..."
    • Choose the repository you want to clone from the list or enter its URL.
    • Choose the local path where you want to clone the repository and click "Clone".

  3. Make Changes:

    • After cloning the repository, you can make changes to the files locally using your preferred code editor.

  4. Commit Changes:

    • Once you've made changes, open GitHub Desktop.
    • You'll see a list of files with changes. Write a summary and description of your changes in the text fields.
    • Click "Commit to main" to commit your changes locally.

  5. Push Changes:

    • To push your changes to the remote repository on GitHub.com, click "Push origin".

  6. Pull Changes:

    • If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin".

  7. Sync Changes:

    • To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step.

That's it! You can now use GitHub Desktop to manage this repository efficiently.

Our Vision

With innovation as our compass and authenticity as our guide, we are committed to delivering engaging content and immersive experiences that bridge the gap between the past, present, and future. Our mission is to empower individuals to engage with history in meaningful and transformative ways, becoming stewards of their own narratives and architects of a brighter tomorrow.

✍️ Feedback and Support

If you encounter any issues or have any feedback or suggestions, please open an issue in the Issues section of this repository. We appreciate your feedback and will respond as soon as possible.

🛡️ License

This project is licensed under the MIT License - see the LICENSE file for details.

💪 Thanks to all Contributors

Thanks to all contributors for helping this project grow! 🍻

🙏 Support

Don't forget to leave a star ⭐️ for this project!