Maritime Museum Ship Tracker (MMST)
This project is building an app that will present educational content and a real-time ship-tracking map for the Hong Kong Maritime Museum.
Folder Structure
- design: UI/UX design files and docs
- docs: Information docs, guides, and reports
- mmst-app: Code for electron app
Tech Stack
- Electron v32.1.2
- NodeJS v20.18.0
- React v18.3.1
And more to be added!
Dev Info
Detailed initial project setup info can be found here
Dev Run Steps
- Install or switch to Node.js v20.18.0
- Navigate to
mmst-app
in your favorite terminal
- Run
npm install
and then npm start
Pull Request Prerequisites
- Run ESLint:
npm run lint
- Fix any ESLint issues, confirm fixes by running ESLint again
- Run Prettier:
npm run format
- Submit Pull Request into main branch