-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |