gatelogue-types 2.0.0-b11 → 2.0.0-b13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,36 @@
1
+ ![](./gatelogue-client/public/gat2-light.png)
2
+
3
+ ![Github Version](https://img.shields.io/github/v/release/MRT-Map/gatelogue)
4
+ ![Docs Status](https://img.shields.io/github/actions/workflow/status/MRT-Map/gatelogue/.github%2Fworkflows%2Fpages.yml?style=flat&label=docs&link=https%3A%2F%2Fmrt-map.github.io%2Fgatelogue%2Fdocs)
5
+ ![GitHub License](https://img.shields.io/github/license/MRT-Map/gatelogue)
6
+ ![GitHub Pages Status](https://img.shields.io/github/actions/workflow/status/MRT-Map/gatelogue/.github%2Fworkflows%2Fpages.yml?style=flat&label=website&link=https%3A%2F%2Fmrt-map.github.io%2Fgatelogue)
7
+
8
+ ![GitHub code size](https://img.shields.io/github/languages/code-size/MRT-Map/gatelogue)
9
+ ![GitHub repo size](https://img.shields.io/github/repo-size/MRT-Map/gatelogue)
10
+ ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/mrt-map/gatelogue/main)
11
+ ![GitHub commits since latest release (branch)](https://img.shields.io/github/commits-since/mrt-map/gatelogue/latest/main?include_prereleases)
12
+ ![GitHub Release Date](https://img.shields.io/github/release-date/MRT-Map/gatelogue)
13
+
14
+ ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/mrt-map/gatelogue/dist?label=last%20data%20update)
15
+
16
+ Database of air, rail, sea, bus routes on the MRT
17
+
18
+ Client is hosted at https://mrt-map.github.io/gatelogue
19
+
20
+ Documentation for the aggregator and data format is located at https://mrt-map.github.io/gatelogue/docs
21
+
22
+ ## development setup
23
+ if you want to use a github codespace, just open one! setup is handled for you, and will take a few minutes. (it's the green code button, under the codespaces tab)
24
+
25
+ if you'd rather do things locally, the easiest way to get started is with dev containers:
26
+
27
+ 1. install docker
28
+ 2. install the [remote development pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) for vscode
29
+ 3. Use Cmd/Ctrl + Shift + P -> 'Clone Repository in Container Volume' to clone this repo (don't use 'reopen in container', as that will conflict with pnpm)
30
+ 4. the container will take a few minutes to install and set up
31
+
32
+ congrats! you did it!
33
+
34
+ run the aggregator with the command `gatelogue-aggregator run`
35
+
36
+ run the client with the command `cd gatelogue-client` and `pnpm run dev`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gatelogue-types",
3
- "version": "2.0.0-b11+8",
3
+ "version": "2.0.0-b13+8",
4
4
  "license": "GPL-3.0-only",
5
5
  "author": {
6
6
  "name": "MRT Mapping Services",
@@ -47,6 +47,7 @@
47
47
  "build:cjs": "tsc --outDir dist/cjs -m commonjs --verbatimModuleSyntax false",
48
48
  "lint": "eslint --fix lib.ts",
49
49
  "format": "prettier --write .",
50
- "doc": "typedoc"
50
+ "doc": "typedoc",
51
+ "prepublish": "cp ../README.md ."
51
52
  }
52
53
  }