Skip to content

weLoveTrainz/MiniMelbourne

Repository files navigation


Logo

MiniMelbourne

An OSS live train map of Melbourne!
View Demo · Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

A demonstration

A while back, I had found a 3D train map of Tokyo, called MiniTokyo-3D and thought it would be a cool idea to replicate it for Melbourne, seeing as VicRoads had recently exposed an API for querying the live data of train positions. So, during UniHack 2022, me and a team of 4 other people came up with a proof of concept: MiniMelbourne!

Right now, you can search for stations, wander around a 3D Melbourne, and view trains gradually move as their positions update now and then.

(back to top)

Built With

(back to top)

Getting Started

If you want to run this locally, clone both the front-end and back-end, then install the required dependencies for both environments. Ideally, set up a virtual environment for the backend, and install the packages locally for the front-end.

Prerequisites

  • npm

    npm install --save
    npm run build
  • backend

    py get_gtfs.py
    py run.py
    

Roadmap

Lots.

  • Station Card Fixes
    • Fix station cards that have weird information
    • Fix misleading to/from city card error
    • Vehicle ID not showing
    • Remove extra occupancy information
  • Overlapping lines
    • Add parallel lines for lines that overlap
    • Make lines thicker
  • Scaling
    • Ensure trains scale
    • Icons take up too much space
  • Progress Bar for a train
    • Add a pop-up bar for where a train is along the line
  • Add route search
  • Animation for train moving

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Sai kumar Murali krishnan - Email: My name (lower caps, no spaces)gmailcom

Project Link: https://github.com/weLoveTrainz/MiniMelbourne

(back to top)

Acknowledgments

TBD.

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •