This repository is where we develop the open source version of MemoLanes together with the community. The open source version contains implementations for most core functionalities. This source code is available to everyone under the standard MIT license.
MemoLanes is a distribution of this repository with our own customizations and optimizations.
本仓库是我们与社区共同开发开源版 迹忆 的地方。 开源版本包含了大部分核心功能的实现。 此源代码依据标准的 MIT 许可证向所有人开放。
迹忆是基于本仓库打造的定制发行版，融合了我们的额外改进与优化。
MemoLanes is a route tracking application designed to conveniently record and securely store your travel footprints while providing rich visualization. Through continuous exploration of the world, you can create unique digital traces, allowing you to revisit and relive your treasured travel memories.
- 🗄️ Your Data Truly Belongs to You
- All journey data is securely stored on your device locally。
- Open source project means open format. Nothing would stop you from coverting your data between different apps/tools. No lock-in!
- 💪 Rich & Powerful Features
- Multi-Layer Support: Switch between your flights and paths on the ground.
- TimeMachine: Watch your journeys evolve on using an interactive timeline.
- And more!
- 🧩 Future-Ready Architecture
- There are many awesome features in the roadmap. With well designed architecture, your existing data can get the full benefits of new features.
- ❤️ Build this app together
- Join the community, contribute to this app and make it the app you want.
迹忆是一款轨迹记录软件，不仅能便捷记录、安全储存你的足迹，更能以丰富的形式可视化旅途数据。通过对世界的不断探索，你能留下独一无二的数字印记，追溯属于你的旅行回忆。
- 🗄️ 你的数据完全属于你
- 旅程数据全部储存在你的本地设备上，确保其安全性。
- 开源项目意味着开放的数据格式。你可以在各种应用或工具之间自由地迁移数据，没有任何阻碍。
- 💪 丰富且强大的功能
- 多图层：自由组合、切换航迹与地面数据。
- 时光机：在时间轴上查看你的轨迹变化。
- 以及更多！
- 🧩 易于扩展的架构
- 更多功能已在路线图中。基于精心设计的底层架构，现有数据可无缝适配新功能升级。
- ❤️ 共建生态
- 加入开发者社区，参与应用开发，共同打造理想应用。
There are two main components of this app: 1. A rust library for the core logic; 2. a flutter project for the app itself. If you are only going to touch the rust core library then only 1 is required. However, working on the flutter project requires a full setup.
- Install Rust.
- Install protobuf.
- Install
just. You can do it withcargo install justor use other package manager mentioned here. - Go to
/app/rustfolder. - (If you are downgrading from a full setup, delete
src/frb_generated.rsif it exists). - Run relevant cargo command to make sure the setup is completed (e.g.
cargo check,cargo test).
- Install Flutter.
- Install flutter_rust_bridge. It is recommnad install the specific version that this project is using by
cargo install 'flutter_rust_bridge_codegen@2.9.0'. The real version can be found usingjust get-frb-versionor looking atapp/pubspec.yaml. - Install yarn.
- Go to
/appfolder. - Create
.envfile and put the Mapbox token in it. An example can be found in.env.example. - Running pre-build via
just pre-build. Note that this need to be reran every time rust api or journey kernel is updated. - Start the app via
flutter run. justprovides many useful commnads, e.g.just format,just check,just test. Consider run those before opening/updating PRs.