Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthewmorek/tramspotter-pwa
Get live departures at your nearest Metrolink tram stop.
https://github.com/matthewmorek/tramspotter-pwa
lambda monorepo vue
Last synced: 3 days ago
JSON representation
Get live departures at your nearest Metrolink tram stop.
- Host: GitHub
- URL: https://github.com/matthewmorek/tramspotter-pwa
- Owner: matthewmorek
- License: mit
- Created: 2019-02-05T22:13:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T02:30:00.000Z (over 3 years ago)
- Last Synced: 2024-12-12T18:15:08.023Z (11 days ago)
- Topics: lambda, monorepo, vue
- Language: JavaScript
- Homepage: https://tramspotter.com/
- Size: 3.84 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/matthewmorek/tramspotter/actions?query=workflow%3A%22Push+Audit+CI%22)
[](./LICENSE)
# Tramspotter
Get live departures at your nearest Metrolink tram stop.
## Getting started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
What you’ll need to get started.
- Git
- NodeJS 12
- npm or Yarn
- `netlify-cli`
### Initial setup
This project requires `netlify-cli` to be present in order to use Nelitfy Dev to run Javacript functions in a local environment.
```
npm install -g netlify-cli
npm install
```
1. Using Git, clone this repository to your local machine.
2. Run `npm install` or `yarn` from inside the project's directory to install all dependencies.
3. Get your API keys from [TfGM developer portal](https://developer.tfgm.com) and [TransportAPI](https://developer.transportapi.com)
4. Run `cp ./.env.local.sample ./.env` and adjust config variables, then make sure to load them to your terminal's session before you launch the app
### Required environment variables
| Variable | Description |
| -------------- | --------------------- |
| `TFGM_API_KEY` | TfGM API Key |
| `TA_APP_ID` | Transport API App ID |
| `TA_APP_KEY` | Transport API App Key |
### Compiles and hot-reloads for development using `netlify-cli`
This command does three things:
- spins up a Webpack HMU server for the app
- spins up a local Node server with hot reloading for lambda functions
- proxies requests for lambdas to hit the local environment instead of Netlify
```
netlify dev
```
### Run the test suite
```
npm run test
npm run test:watch
npm run test:precommit
```
### Lints and fixes files
```
npm run lint
```
### Run Storybook
```
npm run storybook
```