Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hewliyang authored Jun 14, 2024
1 parent 3483e63 commit 0db0713
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,39 @@
<p align="center">
<img alt="NUS BetterNextBus Logo" src="./static/512x512.png" width="70" />
<img alt="NUS NextBus Web Logo" src="./static/512x512.png" width="70" />
</p>
<h1 align="center">
BetterNextBus
NUS NextBus Web
</h1>

# !DISCLAIMER!
If you have been using this at the `nextbus.me` domain, it has expired and I'm not spending money to renew it. You can continue to use it if you'd like at my personal subdomain at https://bus.hewliyang.com

> [!WARNING]
> This project is no longer being maintained but should still work as long as the NUS bus API does not radically change. Additionally, the original [nextbus.me](nextbus.me) domain has expired so it's now only accessible via [bus.hewliyang.com](bus.hewliyang.com)
> [!NOTE]
> A minimal **PWA** for fetching and displaying NUS Internal Shuttle Bus routes & arrival timings because... too many NUS apps
## Features
- Geolocation πŸ“
- Reactive Search πŸ“‘
- Bookmarking πŸ“’
- Dark Mode πŸŒ‘
- Add to home screen πŸ“± (**iOS** users do not get the pop-up)

- Add to home screen πŸ“±

## Developing

This project uses Bun as the package manager but feel free to delete `bun.lockb` and install
with `pnpm`/`npm`/`yarn`.

Install dependencies

```bash
bun install
pnpm install

cp .env.example .env # setup ur config here
```
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

Run the dev server

```bash
bun run dev
pnpm run dev
```

## Disclaimer

Only shuttle timing data is dynamically fetched, while route & stops are served static under `lib/data/<DATA>.json` in order to minimise network usage.

Given this, the data presented including any inaccuracies will be global across all applications.

By using this service, you agree to abide by the [NUS Acceptable Use Policy for IT Resources](https://nus.edu.sg/registrar/docs/info/registration-guides/aup-form.pdf).
[NUS Acceptable Use Policy for IT Resources](https://nus.edu.sg/registrar/docs/info/registration-guides/aup-form.pdf).

0 comments on commit 0db0713

Please sign in to comment.