Walk feature

.gitattributes

@@ -0,0 +1,2 @@
+/Users/ryanlu/Downloads/Projects/mbus-backend-dev/src/assets/walkingCache.json filter=lfs diff=lfs merge=lfs -text
+src/assets/walkingCache.json filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -1,3 +1,5 @@
 node_modules/
 package-lock.json
-.env
+.env
+.vscode/
+src/assets/walkingCache.json

README.md

@@ -1,4 +1,20 @@
-# M-Bus Backend
+<div align="center">
+  <img src="static/logo.png" width="150" alt="Maizebus Logo">
+  <h1>Maizebus Backend</h1>
+
+  <p>
+    <a href="https://mbusdev.github.io/mbus-backend-dev/">
+      <img src="https://img.shields.io/badge/Documentation-Available-blue?style=for-the-badge&logo=typescript" alt="Documentation" />
+    </a>
+    <a href="package.json">
+      <img src="https://img.shields.io/badge/License-ISC-green?style=for-the-badge" alt="License" />
+    </a>
+  </p>
+
+  <p>
+    Backend service for the Magic Bus application. Handles real-time bus tracking, route management, and multi-modal journey planning (bus + walking) using the McRaptor algorithm.
+  </p>
+</div>
 
 ## Setup
 
@@ -14,5 +30,26 @@ To run the backend, run `npm start`.
 
 By default, the service runs on port 3000. To define a port for the service to run on, define an environment variable called `PORT` before running the backend.
 
+## Documentation
+
+This project uses TSDoc for code documentation.
+To compile the static documentation:
+```bash
+npm run docs
+```
+The documentation is served at `http://localhost:3000/docs` or this [link](https://mbusdev.github.io/mbus-backend-dev/).
+
 ## Tests
-To run tests, run `npm test`.
+
+This project uses **Vitest** for fast unit and integration testing.
+
+- Run all tests: `npm test`
+- Run stress tests: `npm run stress-test`
+
+An example of passing the tests is below.
+
+<img src="static/test_example.png" width="300" alt="test example">
+
+
+## Contributing
+Before submitting a pull request to main, please make sure you pass all the tests and can compile docs. If you believe some of the tests faulty or no longer needed after your commit, please contact Andrew Yu or Ryan Lu on Slack.

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,43 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+pre, code { background: var(--code-background); }