tile38-ts
TypeScript client for Tile38 geo-database
File Explorer
Download Latest Version (.zip)- ci.yml
- dependabot.yml
- .gitignore
- commit-msg
- pre-commit
- prepare-commit-msg
- Channel.ts
- Executable.ts
- FSet.test.ts
- FSet.ts
- Get.test.ts
- Get.ts
- index.ts
- Intersects.test.ts
- Intersects.ts
- Nearby.test.ts
- Nearby.ts
- Scan.test.ts
- Scan.ts
- Search.test.ts
- Search.ts
- Set.test.ts
- Set.ts
- SetChan.test.ts
- SetChan.ts
- SetHook.test.ts
- SetHook.ts
- Whereable.ts
- WithClient.ts
- Within.test.ts
- Within.ts
- aofShrink.test.ts
- bounds.test.ts
- channel.test.ts
- chans.test.ts
- config.test.ts
- del.test.ts
- delChan.test.ts
- delHook.test.ts
- drop.test.ts
- errors.test.ts
- events.test.ts
- exists.test.ts
- expire.test.ts
- fexists.test.ts
- flushDb.test.ts
- follower.test.ts
- fset.test.ts
- gc.test.ts
- get.test.ts
- healthz.test.ts
- hooks.test.ts
- info.test.ts
- intersects-all.test.ts
- intersects.test.ts
- json.test.ts
- keys.test.ts
- lazy.test.ts
- leader.test.ts
- nearby.test.ts
- pDel.test.ts
- pDelChan.test.ts
- pDelHook.test.ts
- persist.test.ts
- ping.test.ts
- quit.test.ts
- readOnly.test.ts
- rename.test.ts
- scan.test.ts
- search.test.ts
- server.test.ts
- set.test.ts
- setChan.test.ts
- setHook.test.ts
- stats.test.ts
- ttl.test.ts
- within.test.ts
- Client.ts
- errors.ts
- events.ts
- Follower.ts
- index.ts
- Leader.ts
- parseResponse.ts
- range.ts
- responses.ts
- specs.ts
- Tile38.ts
- .editorconfig
- .gitignore
- .nvmrc
- .prettierrc
- .yarnrc.yml
- CHANGELOG.md
- commitlint.config.js
- docker-compose.yml
- eslint.config.mjs
- jest.config.js
- jest.setup.js
- LICENSE
- package.json
- README.md
- release.config.js
- tsconfig.json
- yarn.lock
# Installation Guide
1. Get the code
git clone https://github.com/iwpnd/tile38-ts
Downloads the entire project code from GitHub to your computer.
cd tile38-ts
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
yarn add @iwpnd/tile38-ts
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)