Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notwoods/hawaii-bus-plus
The best bus app around Hawaii.
https://github.com/notwoods/hawaii-bus-plus
api bus gtfs hawaii jamstack node
Last synced: 19 days ago
JSON representation
The best bus app around Hawaii.
- Host: GitHub
- URL: https://github.com/notwoods/hawaii-bus-plus
- Owner: NotWoods
- Created: 2021-01-16T06:47:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T05:54:24.000Z (3 months ago)
- Last Synced: 2024-10-06T14:54:00.956Z (about 1 month ago)
- Topics: api, bus, gtfs, hawaii, jamstack, node
- Language: TypeScript
- Homepage: https://hawaiibusplus.com
- Size: 18.4 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hawaii Bus Plus
## Contributing
This repository is a monorepo which leverages [pnpm](https://pnpm.js.org/) for dependency management.
To begin, please install `pnpm`:
```bash
$ npm install pnpm -g
$ pnpm recursive install
```
A `.env` file needs to be placed in the root directory, including variables from this template:
```bash
# IPStack API Key
IPSTACK_KEY=xxxxxxxxxxxxxxxxxxxxx
# Google Maps API Key
VITE_GOOGLE_MAPS_KEY=xxxxxxxxxxxxxxxx
# Password for the application
API_KEY=xxxxxxxxxxxxxx
```
### Running
#### Build the API
```bash
pnpm run api
```
Uses the `@hawaii-bus-plus/api-gen` package to generate an API file, which is placed in the client package's public directory.
#### Test the code
```bash
pnpm recursive test
```
Runs the test script in every single package.
#### Run the client
```bash
pnpm run dev
```
Uses the `@hawaii-bus-plus/client` package to start a server on `localhost:3000`. [Vite](https://vitejs.dev/) is used for the dev server and automatically deals with bundling.